Skip to content

Commit

Permalink
Update README.md and CODE_OF_CONDUCT.md
Browse files Browse the repository at this point in the history
  • Loading branch information
syntaxaire committed Jul 30, 2022
1 parent acbf1f2 commit 94dd6af
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
1. We do not tolerate hate speech or symbols associated with hate groups.
2. Do not post any edgy humor or ironic bigotry, even for the sake of ridiculing it.
3. Avoid any misogynist, racist, homophobic, or transphobic content or behavior.
4. Respect other members' existence, pronouns, identity, and lived experience.
4. Respect other members' existence, pronouns, identity, and lived experience.
37 changes: 28 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
[![Build Status](https://dev.azure.com/syntaxaire/hagadias-ci/_apis/build/status/TrashMonks.hagadias?branchName=master)](https://dev.azure.com/syntaxaire/hagadias-ci/_build/latest?definitionId=1&branchName=master)

# hagadias
Python package to extract game data from the [Caves of Qud](http://www.cavesofqud.com/) roguelike.

Python package to extract game data from the [Caves of Qud](http://www.cavesofqud.com/) roguelike.

This library forms the base for several projects:
- the Caves of Qud wiki bot that builds and updates the [official Caves of Qud wiki](https://wiki.cavesofqud.com/)
- the Discord bot that operates on the [Caves of Qud discord server](https://discordapp.com/invite/cavesofqud) (invite link)
- an as yet unannounced project :)

- the Caves of Qud wiki bot that builds and updates the [official Caves of Qud wiki](https://wiki.cavesofqud.com/)
- the Discord bot that operates on the [Caves of Qud discord server](https://discordapp.com/invite/cavesofqud) (invite
link)
- an as yet unannounced project :)

## What does it do?

hagadias allows a user to read game data in the raw format used by the
[Caves of Qud](http://www.cavesofqud.com/) roguelike RPG, including the object tree,
fully colored tiles, and character data. It needs to be passed a path to a local
installation of the game in order to do anything.
[Caves of Qud](http://www.cavesofqud.com/) roguelike RPG, including the object tree, fully colored tiles, and character
data. It needs to be passed a path to a local installation of the game in order to do anything.

## Installation

hagadias requires Python 3.10.

To install the package from this GitHub repository, run
Expand All @@ -22,11 +27,13 @@ or if you're using pipenv,
`pipenv install -e git+https://github.com/trashmonks/hagadias.git@main#egg=hagadias`

## Tile support
Tile support requires the texture files from Caves of Qud to be unpacked into a "Textures" directory
under the working directory. You can use the provided [Brinedump](https://github.com/TrashMonks/brinedump)

Tile support requires the texture files from Caves of Qud to be unpacked into a "Textures" directory under the working
directory. You can use the provided [Brinedump](https://github.com/TrashMonks/brinedump)
mod to export these textures from within the game.

## Usage examples

```
>>> from hagadias.gameroot import GameRoot
>>> GAMEPATH = r'C:\Steam\steamapps\common\Caves of Qud' # Windows
Expand Down Expand Up @@ -103,4 +110,16 @@ Building Qud object hierarchy and adding tiles...
```

## Contributing

See `CONTRIBUTING.md`.

## Contributors

The following people have contributed code to this project:

- egocarib
- Wreckstation
- librarianmage
- HeladoDeBrownie
- elvres
- robbyblum

0 comments on commit 94dd6af

Please sign in to comment.