mirror
/
devilutionX
mirror of https://github.com/diasurgical/devilutionX.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5477 Commits
44 Branches
22 Tags
292 MiB
Tree: 250b2b6dc4
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '250b2b6dc4'
${ noResults }
devilutionX/README.md

64 lines
4.2 KiB
Raw Normal View History Unescape

:note: Add a temp logo
5 years ago
<p align="center">
:memo: Make readme responsive
5 years ago
<img width="554" src="https://user-images.githubusercontent.com/204594/113575181-c946a400-961d-11eb-8347-a8829fa3830c.png">
:note: Add a temp logo
5 years ago
</p>
---
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
[![Downloads](https://img.shields.io/github/downloads/diasurgical/devilutionX/total.svg)](https://github.com/diasurgical/devilutionX/releases)
[![github stars](https://img.shields.io/github/stars/diasurgical/devilutionX.svg)](https://github.com/diasurgical/devilutionX/stargazers)
[![codecov](https://codecov.io/gh/diasurgical/devilutionX/branch/master/graph/badge.svg)](https://codecov.io/gh/diasurgical/devilutionX)
:note: Add a temp logo
5 years ago
[![CircleCI](https://circleci.com/gh/diasurgical/devilutionX.svg?style=shield)](https://circleci.com/gh/diasurgical/devilutionX) [![Build status](https://ci.appveyor.com/api/projects/status/1a0jus2372qvksht?svg=true)](https://ci.appveyor.com/project/AJenbo/devilutionx)
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
Update README.md new discord link
6 years ago
![Discord Channel](https://avatars3.githubusercontent.com/u/1965106?s=16&v=4) [Discord Chat Channel](https://discord.gg/YQKCAYQ)
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:note: Add a temp logo
5 years ago
<p align="center">
:memo: Make readme responsive
5 years ago
<img width="838" src="https://user-images.githubusercontent.com/204594/113578478-26912400-9623-11eb-9ff6-9bd9717462b6.png">
:note: Add a temp logo
5 years ago
</p>
:memo: Update readme
5 years ago
:memo: Add note about things seen in screenshot
5 years ago
<sub>*(The health-bar, and XP-bar are off by default, but can be enabled in the [ini-file](https://github.com/diasurgical/devilutionX/wiki/DevilutionX-diablo.ini-configuration-guide). Widescreen and transparency can also be disabled if preferred)*</sub>
:memo: Clean up readme
5 years ago
# What is DevilutionX
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Fix typos in readme
5 years ago
DevilutionX is a source port of Hellfire/Diablo that strives to make it simple to run the game while providing engine inprovements, bugfixes, and some optional quality of life features.
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Clean up readme
5 years ago
For a full list of changes see our [changelog](docs/CHANGELOG.md).
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Clean up readme
5 years ago
# How To Install:
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Add more systems installation instructions
5 years ago
Download the latest [DevilutionX release](https://github.com/diasurgical/devilutionX/releases) and extract the contents to a location of your choosing or [build from source](#building-from-source).
- Copy `DIABDAT.MPQ` from your CD or GoG installation (or [extract it from the GoG installer](https://github.com/diasurgical/devilutionX/wiki/Extracting-the-.MPQs-from-the-GoG-installer)) to the folder containing the DevilutionX executable or to the data folder.
- To run the Hellfire expansion of Diablo you will need to copy `hellfire.mpq`, `hfmonk.mpq`, `hfmusic.mpq`, `hfvoice.mpq` into the same location as `DIABDAT.MPQ`.
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Fix typos in readme
5 years ago
For more detailed instructions: [Installation Instructions](./docs/installing.md).
:memo: Split build instructions in to it's own document
5 years ago
:memo: Clean up readme
5 years ago
# Contributing
:memo: Split build instructions in to it's own document
5 years ago
:memo: Fix typos in readme
5 years ago
We are always looking for more people to help with [coding](docs/CONTRIBUTING.md), [documentation](https://github.com/diasurgical/devilutionX/wiki), testing the [latest builds](https://app.circleci.com/pipelines/github/diasurgical/devilutionX?branch=master), spreading the word, or simply just hanging out on [the chat](https://discord.gg/YQKCAYQ).
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Clean up readme
5 years ago
# Mods
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Fix typos in readme
5 years ago
We hope to provide a good starting point for mods, in addition to the full Devilution source code we also provide modding tools. Also checkout the list of known [mods based on DevilutionX](https://github.com/diasurgical/devilutionX/wiki/Mods-and-related-projects).
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
:memo: Clean up readme
5 years ago
# Building from Source
:memo: Fix typos in readme
5 years ago
Want to compile the program by yourself? Great! Simply follow the [build instructions](./docs/building.md).
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
# Credits
:memo: move install instructions to docs\installing.md (#1372)
5 years ago
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
- The original Devilution project [Devilution](https://github.com/diasurgical/devilution#credits)
- [Everyone](https://github.com/diasurgical/devilutionX/graphs/contributors) who worked on Devilution/DevilutionX
:memo: Fix typos in readme
5 years ago
- [Nikolay Popov](https://www.instagram.com/nikolaypopovz/) who provided new backgrounds and icons
:memo: Correct punctuation
5 years ago
- And a thanks to all who support the project, report bugs and help spread the word ❤️
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
# Legal
:memo: move install instructions to docs\installing.md (#1372)
5 years ago
Merge branch 'master' of github.com:diasurgical/devilution
6 years ago
DevilutionX is released to the Public Domain. The documentation and functionality provided by DevilutionX may only be utilized with assets provided by ownership of Diablo.
Create README.md
8 years ago
Add note about the the non-commerical nature of the project
6 years ago
The source code in this repository is for non-commerical use only. If you use the source code you may not charge others for access to it or any derivative work thereof.
Use LF for Markdown files instead of CRLF Ensures the contents can be easily copy-pasted into the terminal from most editors on all systems. Otherwise, on Linux, you get 2 newlines for each newline in the source when copying from VS Code.
6 years ago
Diablo® - Copyright © 1996 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.
Merge branch 'master' of github.com:diasurgical/devilution
6 years ago
DevilutionX and any of its maintainers are in no way associated with or endorsed by Blizzard Entertainment®.