Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AeriaVelocity committed Apr 10, 2023
1 parent d409677 commit 5c6560a
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
# Welcome to Sonic the Hedgehog in Doom! ![GitHub repo size](https://img.shields.io/github/repo-size/Sonic-LockandLoad/SonicDoom-Legacy)
*Sonic the Hedgehog in Doom* is a DOOM mod for the GZDoom source port based on Sonic the Hedgehog.
### WARNING!
StHiD: Legacy is in the middle of being converted from [Sonic: Lock & Load](https://github.com/Sonic-LockandLoad/Sonic-LockandLoad). It's not recommended you play this mod at the moment.
<h1 align=center>Welcome to Sonic the Hedgehog in Doom!</h1>

<img src=https://sonic-lockandload.github.io/STH-In-DoomLogo.png>

### Sonic the Hedgehog in DOOM: Legacy Edition is a Sonic the Hedgehog gameplay mod for DOOM, based on [Sonic: Lock & Load](https://github.com/sonic-lockandload/sonic-lockandload).

Unlike its big brother, StHiD: Legacy is primarily a gameplay-only experience intended to be played with regular DOOM, or, optionally, your favourite map packs.

Also different is the version naming systems. S:L&L versions have their own version numbers, e.g. v1.3.3, v1.4, but StHiD: Legacy uses dates, like 2023-04-10.

The reason for this is that this project is less important than Sonic: Lock & Load, and so more updates can be pushed out, and I don't have to keep coming up for version numbers, which means less stress for me.

To play an unstable version of StHiD: Legacy, use `git clone` to clone it to your computer, and open the cloned repo with GZDoom, like you would with a WAD or PK3. You can update with `git pull`.

Unstable versions are recommended if you want to try the latest stuff and you don't care much about waiting for the next release.

## Copyright
Sonic the Hedgehog in DOOM is a fan-made DOOM mod. All copyrights go to their intended holders.<br>
Sonic the Hedgehog is property of SEGA. DOOM is property of id Software.

0 comments on commit 5c6560a

Please sign in to comment.