Documentation - gridpunx-team/gridpunx GitHub Wiki

This is the central page for documentation of the gridpunx code.

Guides, tutorials, and howtos

Guides, tutorials, and basic procedures for using/modifying the code to make your own world. More information is available in the howto page.

List of howto documents:

  • There are no howto documents yet. 😞

Developer (source code) documentation

The source code documentation is meant for people who want to modify or improve on the gridpunx code.

List of source code documents:

  • Commands – Commands (and CommandSets) that have been created or modified for gridpunx.
  • Typeclasses – Detailed information for all files in the gridpunx/typeclasses folder.
  • World – Detailed information for all files and subfolders of the gridpunx/world folder.

Admin documentation

Documentation for Admins.

List of Admin documents:

  • Nothing yet 😞

Builder documentation

Documentation for Builders.

List of Builder documents:

  • Nothing yet 😞

Player documentation

One of the main goals is to encourage the use of in-game resources for player information. Eventually, this section will have a few resources for players, but

List of player documents:

  • Nothing yet 😞

External Resources

  • Evennia’s Documentation – The documentation for Evennia is extremely thorough, and will likely be referenced throughout the gridpunx documentation. Some of the gridpunx documentation may contain copied and modified segments of Evennia’s documentation, but this will be avoided as much as possible. (!COPYRIGHT NOTE! If a page is copied from Evennia’s documentation into the documentation from gridpunx, either in whole or in part, then attribution to the source content will be clearly given on that page.)
⚠️ **GitHub.com Fallback** ⚠️