-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This wiki serves as documentation for the Gilbo RPG API. For a complete example of how to use Gilbo, see Morrisland.
Gilbo is an object-oriented interface for games written in Python 3.6. Gilbo allows creation of items, inventories, entity stat lists, attacks, and attack lists. The collection of these objects is called an "entity". Some examples of entities would be the player, enemies, NPCs, or vendors.
It allows for creation of basic locations, and movement throughout them by players and entities. Quests can also be created, and they have multiple stages that can be used in tandem with locations, NPCs, and events to determine the state of the world around you.
All classes use dictionaries to store variables, but properties allow you to access them more easily.
Gilbo also has a basic save/load system, which makes it easy for developers who aren't sure how to program one.
Finally, there are several debug features that help developers keep track of what they have created. The object tracker can list all items that exist in the program, as well as search for specific types of objects and pass them to functions.
Gilbo depends on four libraries:
- django dispatch
- NumPy
- colorama
- dill
Of these, two are included with Gilbo. The others must be installed manually with pip, which is included with the latest version of python.
To quickly install the dependencies, navigate to the Gilbo-API folder, and then:
On OSX or Linux, enter
python3.6 -m pip install -r requirements.txt
On Windows, enter:
python -m pip install -r requirements.txt
To import Gilbo, just add the project folder as a sub-directory to your project folder, and then put these lines of code to the top of your main project file:
from sys import path path.append('./Gilbo-API/')
Add the following line if you want to use the provided dependencies instead of your own:
path.append('./Gilbo-API/deps/')