cass.cityboundforest.com
A framework for the Godot engine to create TTRPG games for Advanced 5th Edition, Pathfinder 2nd Edition, and more
Updating README.md
+12
-6
+12
-6
README.md
+12
-6
README.md
···
3
3
4
4
All content included in this repository is accessed through the Open RPG Creative (ORC) License. Any mechanical content created using this framework is required to be licensed back to the community through the ORC License. For more information about the ORC license, please see [here](https://paizo.com/orclicense).
5
5
6
-
## Pathfinder 2E Updates
6
+
## System Updates
7
+
8
+
### Pathfinder 2E Updates
7
9
8
10
At time of writing, this repository will only include character creation options present in the Player Core. Player Core 2 content will be added once that is finished.
9
11
10
-
## OGL 5th Edition (O5E) Updates
12
+
### OGL 5th Edition (O5E) Updates
11
13
12
14
At time of writing, the SRD 5.2 has been published. I have not looked it over, but I will be including it once I finish with Pathfinder 2nd Edition.
13
15
14
-
## Advanced 5th Edition (A5E) Updates
16
+
### Advanced 5th Edition (A5E) Updates
15
17
16
18
At time of writing, I have not begun any efforts to add A5E into the framework. Once O5E has been finished and integrated, I will begin to integrate A5E as accessed through the ORC license (see above).
17
19
18
-
## Starfinder 2E Updates
20
+
### Starfinder 2E Updates
19
21
20
22
At time of writing, Starfinder 2E is still in its playtest phase. Once the game is fully released, I will look at integrating it into this framework.
21
23
22
-
## Other Systems
24
+
### Other Systems
25
+
26
+
With the way this framework is being developed, I intend to make this as modular as possible. Thus all one must do is create a "mod" of sorts to add in the data and code needed for any other system. If you would like to have me add them officially, I can do an audit of your code and data and add it as a submodule of this repository. If the schema is too limiting for a system you'd like to add, please let me know by either [submitting a pull request](https://tangled.sh/@cass.cityboundforest.com/dice-wire/pulls/new) or by sending me a DM on [BlueSky](https://bsky.app/profile/did:plc:lsxnahuhdg6llq7lpo3wq6kf).
27
+
28
+
## Usage
23
29
24
-
With the way this framework is being developed, I intend to make this as modular as possible. Thus all one must do is create a "mod" of sorts to add in the data and code needed for any other system. If you would like to have me add them officially, I can do an audit of your code and data and add it as a submodule of this repository. If the schema is too limiting for a system you'd like to add, please let me know by either [submitting a pull request](https://tangled.sh/@cass.cityboundforest.com/dice-wire/pulls/new) or by sending me a DM on [BlueSky](https://bsky.app/profile/did:plc:lsxnahuhdg6llq7lpo3wq6kf).
30
+
You can, of course, just use this as a usual Lua program. The code assumes you load the class file, call it, and assign the resulting function returned to a global variable `class`. You can then load the `hooks` file, along with any other libraries you'd like (i.e. the different systems). Due to the nature of this framework, I will not be writing code to load a system's code, but it shouldn't be too difficult to do so.