Skip to content

Commit

Permalink
README update: general update
Browse files Browse the repository at this point in the history
  • Loading branch information
M. Sz committed Jan 25, 2021
1 parent 841c557 commit e61da0f
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 5 deletions.
74 changes: 69 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,80 @@
[Development Live stream](https://www.twitch.tv/essial/)\
[Support us on Patreon](https://www.patreon.com/bePatron?u=37261055)

HellSpawner is the toolset used for developing games on the [OpenDiablo2](https://github.com/OpenDiablo2/OpenDiablo2) engine.
## About this project

It is currently early in development and not ready for active use.
HellSpawner is the toolset used for developing games on the [OpenDiablo2](https://github.com/OpenDiablo2/OpenDiablo2) engine.

## Getting the source

After pulling the source, you need to grab the submodules in order to run the project.
You can do so by running the following command in the root of the project:
To download code use a following command:

`git clone --recurse-submodules https://github.com/OpenDiablo2/hellspawner`

or after pulling the source, download submodules:

`git submodule update --init --recursive`

Thenn, you need to download go's dependencies:

In root of your project run `go get -d`

Run project by `go run .`

If you're using Unix-based OS, you can build project with included building script: run `./build.sh`

## Contributing

If you find something you'd like to fix that's obviously broken, create a branch, commit your code, and submit a pull request. If it's a new or missing feature you'd like to see, add an issue, and be descriptive!

If you'd like to help out and are not quite sure how, you can look through any open issues and tasks, or ask
for tasks on our discord server.


### Lint Errors
We use `golangci-lint` to catch lint errors, and we require all contributors to install and use
it. Installation instructions can be found [here](https://golangci-lint.run/usage/install/).


## VS Code Extensions

The following extensions are recommended for working with this project:

- ms-vscode.go
- defaltd.go-coverage-viewer

When you open the workspace for the first time, Visual Studio Code will automatically suggest these extensions for installation.

Alternatively you can get to it by going to settings <kbd>Ctrl+,</kbd>, expanding `Extensions` and selecting `Go configuration`,
then clicking on `Edit in settings.json`. Just paste that section where appropriate.

## Status

For now (january 2021) we can use HellSpawner to:

* create projects

* browse MPQ archives

* view following file formats:

- COF, DC6 and DCC animations

- DS1 and DT1 map's tiles

- WAV sound files

- TXT - data tables

- TBL - font tables

- TBL - string tables

- PL2 - palettes

Much work has been made in the background, but a lot of work still has to be done for the project to be complete.

Feel free to contribute!

## Screenshots
![Screenshot](screenshot1.png)
![Screenshot](docs/overview.png)
File renamed without changes

0 comments on commit e61da0f

Please sign in to comment.