gravestench/OpenDiablo2
1
1
Fork 0
mirror of https://github.com/OpenDiablo2/OpenDiablo2 synced 2024-06-08 00:40:43 +00:00
Code Issues Releases Wiki Activity

Updated readme information

Browse Source
This commit is contained in:
Tim Sarbin 2019-10-24 09:38:57 -04:00
parent 08c8e10502
commit 5b719eb018
1 changed files with 7 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -5,11 +5,11 @@
## About this project
OpenDiablo2 is an ARPG game engine in the same vein of the 2000's games, and supports playing Diablo 2. The engine is written in C# and is cross platform. However, please note that this project does not ship with the assets or content required to play Diablo 2. You must have a legally purchased copy of [Diablo 2](https://us.shop.battle.net/en-us/product/diablo-ii) and its expansion [Lord of Destruction](https://us.shop.battle.net/en-us/product/diablo-ii-lord-of-destruction) installed on your computer in order to run that game on this engine. If you have an original copy of the disks, those files should work fine as well.
OpenDiablo2 is an ARPG game engine in the same vein of the 2000's games, and supports playing Diablo 2. The engine is written in golang and is cross platform. However, please note that this project does not ship with the assets or content required to play Diablo 2. You must have a legally purchased copy of [Diablo 2](https://us.shop.battle.net/en-us/product/diablo-ii) and its expansion [Lord of Destruction](https://us.shop.battle.net/en-us/product/diablo-ii-lord-of-destruction) installed on your computer in order to run that game on this engine. If you have an original copy of the disks, those files should work fine as well.
Currently we are working on features necessary to play Diablo 2 in its entireity, but will then expand with tools and plugin support to allow modding, as well as writing completely new games with the engine.
Currently we have the main menu, credits screen, hero selection screen, map rendering, character animations, the beginnings of map generation, some equipment management, and a client/server stack. This project is still early in development and is not yet at a playable state.
We are in the process of moving to a go based engine. We are taking good bits from the original C# base and migrating it over to the new engine code.
Please note that **this game is neither developed by, nor endorsed by Blizzard or its parent company Activision**.
@ -17,28 +17,15 @@ Diablo 2 and its content is ©2000 Blizzard Entertainment, Inc. All rights reser
ALL OTHER TRADEMARKS ARE THE PROPERTY OF THEIR RESPECTIVE OWNERS.
## Building On Windows
To build this engine, you simply need to have [Microsoft Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) installed with C#/Windows support. Also make sure that only the x64 architecture is selected as we are not shipping 32-bit versions of SDL currently.
## Building
## Building On Linux
You need to have MonoDevelop installed, as well as any depenencies for that. You also need LibSDL2 installed (installing via your favorite package manager should be fine).
In the root folder, run `go get -d ./src/App` to pull down all dependencies.
## Command Line Parameters
| Long Name | Description |
| ------------ | ------------------------------------------------------------ |
| --datapath | (-p) Defines the path where the data files can be found |
| --hwmouse | Use the hardware mouse instead of software |
| --mousescale | When hardware mouse is enabled, this defines the pixel scale of the mouse. No effect for software mode |
| --fullscreen | (-f) When set, the game launches in full screen mode at 800x600. |
To run the project, run `go run ./src/App` from the root project folder.
By default OpenDiablo2 assumes the media files are in the same folder as itself. At minimum you'll most likely want to specify this option:
```-p "C:\Program Files (x86)\Diablo II"```
Substitute the path with wherever you have installed Diablo 2 and its expansions.
When running via VisualStudio, go to the debug section of the OpenDiablo2 project and specify the command line options there. At minimum you'll want to specify the path to the data files.
## Configuration
The engine is configured via the `config.json` file.
## Contributing