1
1
mirror of https://github.com/OpenDiablo2/OpenDiablo2 synced 2024-11-17 18:06:03 -05:00
OpenDiablo2/README.md

50 lines
3.5 KiB
Markdown
Raw Normal View History

2018-11-26 22:53:10 -05:00
# OpenDiablo2 [![Build status](https://ci.appveyor.com/api/projects/status/jx83as0ku784r5vh?svg=true)](https://ci.appveyor.com/project/essial/opendiablo2)
2018-11-26 22:42:22 -05:00
2018-11-23 11:10:21 -05:00
An open source re-implementation of Diablo 2 in C#
2018-11-23 08:27:55 -05:00
2018-11-23 13:33:23 -05:00
[Join us on Discord!](https://discord.gg/pRy8tdc)\
[Development Live stream](https://www.twitch.tv/essial/)
2018-11-22 00:21:05 -05:00
2018-11-22 00:58:43 -05:00
<img src="https://raw.githubusercontent.com/essial/OpenDiablo2/master/Screenshot.png" />
2018-11-23 00:42:07 -05:00
<img src="https://raw.githubusercontent.com/essial/OpenDiablo2/master/Screenshot2.png" />
2018-11-22 00:58:43 -05:00
2018-11-22 01:12:58 -05:00
## About this project
This is an attempt to re-create Diablo 2's game engine in C#, and make it cross platform as well. This project does not ship with the assets or content required to work. 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 this engine. If you have an original copy of the disks, those files should work fine as well.
2018-11-22 01:12:58 -05:00
Please note that **this game is neither developed by, nor endorsed by Blizzard or its parent company Activision**.
This game is a clean-room implementation based on observations of how the original game works. Aside from the data file formats themselves, we have not and will not reverse engineer the original binaries of the game in an attempt to copy or duplicate intellectual property.
Diablo 2 and its content is ©2000 Blizzard Entertainment, Inc. All rights reserved. Diablo and Blizzard Entertainment are trademarks or registered trademarks of Blizzard Entertainment, Inc. in the U.S. and/or other countries.
ALL OTHER TRADEMARKS ARE THE PROPERTY OF THEIR RESPECTIVE OWNERS.
2018-11-25 19:57:16 -05:00
## Building On Windows
2018-11-23 00:55:53 -05:00
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.
2018-11-25 19:57:16 -05:00
## 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).
2018-11-22 01:16:32 -05:00
## 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 |
2018-11-29 18:20:38 -05:00
| --fullscreen | (-f) When set, the game launches in full screen mode at 800x600. |
2018-11-22 00:21:05 -05:00
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"```
2018-11-22 00:21:05 -05:00
Substitute the path with wherever you have installed Diablo 2 and its expansions.
2018-11-22 01:16:32 -05:00
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.
2018-11-22 01:16:32 -05:00
## Contributing
2018-11-26 22:42:22 -05:00
If you find something you'd like to fix thats 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!
2018-11-22 01:16:32 -05:00
If you'd like to help out and are not quite sure how, you can look through any open issues and tasks.