Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Challenge9 committed Apr 29, 2023
1 parent 33ba611 commit d5782cb
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Doom 2D Forever

## Description
**Doom 2D: Forever** is a modern version of a Russian freeware doom game Doom 2D.

This open source multiplatform project, written from scratch, is designed to reproduce the original game with significant
Expand All @@ -9,11 +11,12 @@ improvements in gameplay, graphics and logic.

![MegaDM](docs/images/screenshots/screenshot-megadm.png)

# Build
Requirements:
- FPC >= 3.0.4
- libenet >= 1.3.13
## Install

### Flatpak
Doom 2D: Forever has a Flatpak manifest, available at (https://github.com/Challenge9/org.doom2d.forever)

## Build
```
git clone --recurse-submodules https://github.com/Challenge9/doom2d-forever
cd doom2d-forever
Expand All @@ -27,13 +30,12 @@ Requirements:
Windows binaries will require the appropriate DLLs (SDL2.dll, SDL2_mixer.dll or
FMODEx.dll, ENet.dll, miniupnpc.dll), unless you choose to static link them.

**Important** Remember to clear the cache directory (`build/tmp` by default) after you've built the game!
**NOTE** Remember to clear the cache directory (`build/tmp` by default) after you've built the game!

# Run
## Run
- If you've followed build instructions above, `../../build/bin/Doom2DF`
- If Doom2DF is installed in the system PATH, `Doom2DF`

# Screenshots
![MegaDM](docs/images/screenshots/screenshot-megadm.png)
## Screenshots
![Castlevania.wad](docs/images/screenshots/screenshot-castlevania.png)
![Prikolsoft.wad](docs/images/screenshots/screenshot-prikolsoft.png)

0 comments on commit d5782cb

Please sign in to comment.