Skip to content
This repository has been archived by the owner on Jun 30, 2023. It is now read-only.

Latest commit

 

History

History
73 lines (56 loc) · 3.09 KB

README.md

File metadata and controls

73 lines (56 loc) · 3.09 KB
Raw

Code style: black Flow: Gitflow

ProjectOr

ProjectOr is a (work in progress) generative programming language intended for RPG campaigns and games alike. Its aim is to allow its users to define generation templates whereby the language understands how to generate adequate values when queried to do so. The name "ProjectOr" (bring your attention to the capitalized 'O' at the end) is a reference to its expression-based nature.

Developer Note: ProjectOr, for me, has the secondary purpose of being a learning project. That is one of the reasons why I chose Python to be the language behind it. In the future, when the amount of knowledge to be cultivated through this project is about as small as meaningless, I have plans to port most of it to C in order to greatly improve performance.

Streamer Note: a lot of the production process and work being done on the language will be streamed at my Twitch channel. I do plan on sharing progress at Twitter as well, although I'm not very fond of it. A seemingly better idea is to make a YouTube series out of it (once I've decided on it the links for either my Twitter or YouTube will be here).

Key functionality goals (an incomplete list):

  • Expression Interpretation
  • Variable Assignment and Access
  • Range Generation
  • Dice Objects
  • Non-Numerical Value Generation
  • Non-Numerical Dice Objects
  • Generation Templates
  • Functions
  • Keyword Definitions
  • Aliases

Running ProjectOr

The recommended way to run ProjectOr is

python -OO -S -m projector <options>

where <options> signifies ProjectOr's initialization options (initialize with -h or --help to learn more), although you can do without the -OO -S fragment if you wish (or use any Python options).

I would like to emphasize some special ProjectOr options:

  • -d or --debug makes ProjectOr not virtualize Python exceptions but rather raise them in the standard manner, thus displaying the stack trace.
  • -t or --token only runs the tokenizer and prints the generated tokens' display representation.
  • -p or --parser (to be implemented) only runs the parser and prints the generated expressions' display representation.

The ProjectOr Development Journal

I try my best to find time to write a development journal, explaining the idea behind some of my decisions and how stuff came to be. If I ever write good documentation on ProjectOr, it will most probably explain all the hows and whens, but not the whys, which is to be addressed by the PDJ.

Currently, you can find all the PDJ entries in the PDJ/ folder of this repository. In the future, PDJ's will be in their own repository, or will remain in the main repo but under a different branch made specifically for them.

At the time no one besides the project founder is allowed to write PDJs for the main repo, but this could change in the future.