openmohaa/README.md

113 lines
2.3 KiB
Markdown
Raw Normal View History

2023-02-03 18:48:42 +01:00
# OpenMoHAA
/ _ \ _ __ ___ _ __ | \/ |/ _ \| | | | / \ / \
| | | | '_ \ / _ \ '_ \| |\/| | | | | |_| | / _ \ / _ \
| |_| | |_) | __/ | | | | | | |_| | _ |/ ___ \ / ___ \
\___/| .__/ \___|_| |_|_| |_|\___/|_| |_/_/ \_\/_/ \_\
|_|
2019-07-03 22:10:46 +02:00
2023-02-03 18:48:42 +01:00
## Discord
2023-02-03 18:48:42 +01:00
[![Discord Banner 1](https://discordapp.com/api/guilds/596049712579215361/widget.png?style=banner2)](https://discord.gg/NYtH58R)
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
## Current State
2023-02-03 18:48:42 +01:00
### Server
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
The server version can successfully be built. There are few unimplemented stuff from the game library :
2023-02-03 18:48:42 +01:00
- Actor
- Vehicle
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
### Client
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
There is currently no client build because the client code is currently unusable. Here is what's missing or unimplemented :
2023-02-03 18:48:42 +01:00
- cgame (using F.A.K.K build)
- rendering (mostly advanced)
- sound (must be reworked)
- UI
2023-02-03 18:48:42 +01:00
## Running
2023-02-03 18:48:42 +01:00
Backup the existing **gamex86.dll** (rename it to **gamex86.bak**).
2023-02-03 18:48:42 +01:00
a) extract archive to your MOHAA installation directory.
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
-or-
2023-02-03 18:48:42 +01:00
b) Copy all pak*.pk3 files and the sound/ directory from your **MOHAA/main** directory into openmohaa's 'main' directory.
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
If you have problems running the game :
2023-02-03 18:48:42 +01:00
You may need to install Microsoft Visual C++ 2015/2017/2019/2022 Redistributable from
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist?view=msvc-170
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
You can now start a local OpenMOHAA server or play on a server.
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
## Compiling
2023-02-03 18:48:42 +01:00
These are the tools required for all platforms :
2023-02-07 21:20:15 +01:00
- CMake >= 3.5
2023-02-07 20:55:37 +01:00
- Flex and Bison (currently not used)
2023-02-03 18:48:42 +01:00
The installation directory can be set to MOHAA directory.
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
### Linux
2023-02-07 20:55:37 +01:00
These are the tools required on Unix :
- Clang or GCC
2023-02-08 14:07:26 +01:00
A C++11 compiler is required. At least **clang-5.0** or **gcc-5** should work (tested on Ubuntu 16.04).
2023-02-07 20:55:37 +01:00
2023-02-03 18:48:42 +01:00
1 line install command with latest clang version : `sudo apt-get install -y ninja-build cmake make clang-15 lld-15 flex bison`
2023-02-03 18:48:42 +01:00
### Windows
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
Visual Studio (2019 or 2022) is generally preferred.
2023-02-03 18:48:42 +01:00
## Third party
2023-02-03 18:48:42 +01:00
### SDL
2019-07-03 22:24:21 +02:00
http://www.libsdl.org/
download Source code, compile
2023-02-03 18:48:42 +01:00
### OpenAL
2019-07-03 22:24:21 +02:00
2023-02-03 18:48:42 +01:00
https://www.openal.org/ download OpenAL soft source
2016-03-27 11:49:47 +02:00
run cmake on OpenAL, compile
2023-02-03 18:48:42 +01:00
### LibMAD
2019-07-03 22:24:21 +02:00
http://www.underbit.com/products/mad/
download source code, compile
2023-02-03 18:48:42 +01:00
### cURL
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
https://curl.se/
2023-02-03 18:48:42 +01:00
### Libogg
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
https://github.com/gcp/libogg
2023-02-03 18:48:42 +01:00
### Libvorbis
2023-02-03 18:48:42 +01:00
https://xiph.org/vorbis/
2023-02-03 18:48:42 +01:00
### Libopus
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
https://opus-codec.org/
2016-03-27 11:49:47 +02:00
2023-02-03 18:48:42 +01:00
## URL
2023-02-03 18:48:42 +01:00
- https://openmohaa.sourceforge.net/
- https://x-null.net/