trolltreasure
Repository containing python package for the Troll Treasure game, as described in the Alan Turing Institute's Research Software Engineering (RSE) course.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.1%) to scientific vocabulary
Repository
Repository containing python package for the Troll Treasure game, as described in the Alan Turing Institute's Research Software Engineering (RSE) course.
Basic Info
- Host: GitHub
- Owner: cobrbra
- License: mit
- Language: Python
- Default Branch: main
- Size: 15.6 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Troll Treasure Game
This is Troll Treasure!
Run troll treasure from python or from the command line.
Installation
Install with pip from GitHub:
pip install git+https://github.com/cobrbra/TrollTreasure.git
Or clone the repository and install manually:
git clone https://github.com/cobrbra/TrollTreasure.git
cd TrollTreasure
pip install .
## Dungeon files
To play the game you need a dungeon specification file. A few samples are provided in the dungeons/ folder available on GitHub (if you have cloned the repository these will be available directly, otherwise follow the link and download a sample dungeon file).
## Playing the game
Now let's play!
### (From the command line)
This option is simplest. Use the play command with the option -d to specify a dungeon file, e.g.
play -d dungeons/dungeon.yml
### (From python)
This option allows for maximum control. Launch a python shell from the command line with python or python3.
Then load a dungeon file and begin a game as follows:
```
from trolltreasure import dungeon, game d = dungeon.Dungeon.fromfile("dungeons/dungeon.yml") g = game.Game(d) g.run() ```
To see all the possible options available through this route (more than are available through the command line) see the documentation.
Owner
- Login: cobrbra
- Kind: user
- Repositories: 3
- Profile: https://github.com/cobrbra
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Bradley" given-names: "Jacob" orcid: "" - family-names: "Else" given-names: "Anyone" orcid: "" title: "TrollTreasure" version: 0.0.1 doi: not.yet date-released: 2022-11-07 url: "https://github.com/cobrbra/TrollTreasure"