gravestench/OpenDiablo2
1
1
Fork 0
mirror of https://github.com/OpenDiablo2/OpenDiablo2 synced 2024-11-17 18:06:03 -05:00
Code Issues Releases Wiki Activity

Merge pull request #1085 from gucio321/readme-update

Browse Source 
Readme update: status + formatting
This commit is contained in:
gravestench 2021-03-11 22:18:37 -08:00 committed by GitHub
commit 9cb5f2ef6b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -1,4 +1,5 @@
# OpenDiablo2 # OpenDiablo2
[![CircleCI](https://circleci.com/gh/OpenDiablo2/OpenDiablo2/tree/master.svg?style=svg)](https://circleci.com/gh/OpenDiablo2/OpenDiablo2/tree/master) [![CircleCI](https://circleci.com/gh/OpenDiablo2/OpenDiablo2/tree/master.svg?style=svg)](https://circleci.com/gh/OpenDiablo2/OpenDiablo2/tree/master)
![Logo](d2logo.png) ![Logo](d2logo.png)
@ -8,7 +9,7 @@
[Support us on Patreon](https://www.patreon.com/bePatron?u=37261055) [Support us on Patreon](https://www.patreon.com/bePatron?u=37261055)
We are also working on a toolset:\ We are also working on a toolset:\
[https://github.com/OpenDiablo2/HellSpawner](https://github.com/OpenDiablo2/HellSpawner)\ <https://github.com/OpenDiablo2/HellSpawner>\
Please consider helping out with this project as well! Please consider helping out with this project as well!
## About this project ## About this project
@ -25,7 +26,7 @@ ALL OTHER TRADEMARKS ARE THE PROPERTY OF THEIR RESPECTIVE OWNERS.
## Status ## Status
At the moment (december 2020) the game starts, you can select any character and run around Act1 town. At the moment (march 2021) the game starts, you can select any character and run around Act1 town.
You can also open any of the game's panels. You can also open any of the game's panels.
Much work has been made in the background, but a lot of work still has to be done for the game to be playable. Much work has been made in the background, but a lot of work still has to be done for the game to be playable.
@ -59,14 +60,14 @@ for tasks on our discord server.
**As of Oct. 26, 2020 we will no longer be accepting pull requests that introduce lint errors.** **As of Oct. 26, 2020 we will no longer be accepting pull requests that introduce lint errors.**
We use `golangci-lint` to catch lint errors, and we require all contributors to install and use 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/). it. Installation instructions can be found [here](https://golangci-lint.run/usage/install/).
## VS Code Extensions ## VS Code Extensions
The following extensions are recommended for working with this project: The following extensions are recommended for working with this project:
- ms-vscode.go * ms-vscode.go
- defaltd.go-coverage-viewer * defaltd.go-coverage-viewer
When you open the workspace for the first time, Visual Studio Code will automatically suggest these extensions for installation. When you open the workspace for the first time, Visual Studio Code will automatically suggest these extensions for installation.
@ -76,7 +77,7 @@ then clicking on `Edit in settings.json`. Just paste that section where appropri
## Configuration ## Configuration
The engine is configured via the `config.json` file. By default, the configuration assumes that you have installed Diablo 2 and the The engine is configured via the `config.json` file. By default, the configuration assumes that you have installed Diablo 2 and the
expansion via the official Blizzard Diablo2 installers using the default file paths. If you are not on Windows, or have installed expansion via the official Blizzard Diablo 2 installers using the default file paths. If you are not on Windows, or have installed
the game in a different location, the base path may have to be adjusted. the game in a different location, the base path may have to be adjusted.
## Profiling ## Profiling
@ -124,9 +125,9 @@ which will be updated over time with new requirements.
## Additional Credits ## Additional Credits
- Diablo2 Logo * Diablo2 Logo
- Jose Pardilla (th3-prophetman) * Jose Pardilla (th3-prophetman)
- DT1 File Specifications * DT1 File Specifications
- Paul SIRAMY (http://paul.siramy.free.fr/_divers/dt1_doc/) * Paul SIRAMY (http://paul.siramy.free.fr/\_divers/dt1\_doc/)
- Other Specifications and general info * Other Specifications and general info
- Various users on [Phrozen Keep](https://d2mods.info/home.php) * Various users on [Phrozen Keep](https://d2mods.info/home.php)