Skip to content

Commit

Permalink
Implement CLI build tools (#3)
Browse files Browse the repository at this point in the history
* restructure and implement CLI build system

* remove coffee tutorial bin reference

* remove cmds directory

* Update Readme

* Remove api folder

* update readme
  • Loading branch information
frankieali authored Apr 25, 2019
1 parent d04084c commit afb22ed
Show file tree
Hide file tree
Showing 398 changed files with 635 additions and 5,019 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
.vscode
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,26 @@
# Open Legend Core Rules Compendium
This project is focused on bringing the core rules of Open Lengend to [Roll20.net](https://www.roll20.net). A [compendium](https://wiki.roll20.net/Compendium) in Roll20 is a series of indexed and categorized webpages that can be browsed outside the VTT (Virtual Table Top), but can also be used within your games for quick rule searches and populating fields on your character sheets like equipment and feats via drag and drop capability. This project is following the [compendium guidelines](https://wiki.roll20.net/Building_Compendiums) posted by Roll20.

## How to build compendium JSON files

1. Clone this repository
2. Path into your repo directory from terminal/command prompt
3. `npm install` to set up modules
4. `npm install -g ./` to install the app from local source code
5. Use `OLC b` (OLC = Open Legend Compendium) (b = build) to kick off the build prompts
1. Select your category to build
2. Select your source material to include
3. Files will be saved to `./dist/` directory

## Changelog

#### April 25th 2019
- Implemented CLI build system using Node and [Commander](https://github.com/tj/commander.js)
- Can build one category or the entire compendium
- Added ability to support multiple source books/folders (Testing with one Amaurea's Dawn item)
- api folder removed now that files can be built


#### April 19th 2019
- Updating some of the object key names for consistency
- Fixed markup inside string objects that are parsed using `JSON.parse()`
Expand Down Expand Up @@ -38,9 +56,10 @@ This project is focused on bringing the core rules of Open Lengend to [Roll20.ne
As of today, (May 30th 2018) the Roll20 team has notified me that they are currntly not onboarding new compendium creators. I'm hoping to get this compendium as close to their requirements as possible so when they are ready to accepted community generated compediums we'll be all ready to upload.

## TODOs
1. Double check all data before beta release
2. Write a script that can auto generate the api files
1. ~~Double check all data before beta release~~
2. ~~Write a script that can auto generate the api files~~
3. Add additional sections
1. archetypes
2. attributes
3. core rules content pages
3. core rules content pages
4. Sort data by name when multiple sources selected
187 changes: 0 additions & 187 deletions api/armor.json

This file was deleted.

Loading

0 comments on commit afb22ed

Please sign in to comment.