Archive/openmohaa
0
0
Fork 0
mirror of https://github.com/openmoh/openmohaa.git synced 2025-04-28 21:57:57 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Update the documentation to reflect the current state of the project

Browse source
This commit is contained in:
smallmodel 2024-08-24 01:03:36 +02:00
parent 32b0b2dfac
commit 1c8b4a1922
No known key found for this signature in database
GPG key ID: A96F163ED4891440
3 changed files with 18 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -26,6 +26,10 @@ The main goal of OpenMoHAA is to ensure the future and continuity of **Medal of
## Current state ## Current state
### Single-player
The entire single-player campaign can be played from start to end. There may be occasional bugs though; if you encounter any, please create a GitHub issue describing them.
### Multiplayer ### Multiplayer
The Multiplayer part is almost fully stable. The Multiplayer part is almost fully stable.
@ -34,13 +38,9 @@ Server admins can use OpenMoHAA to [host](docs/getting_started_installation.md#s
All game modes including `Tug-of-War` from Medal of Honor: Spearhead, and `Liberation` from Medal of Honor: Breakthrough are implemented and are working as intended. Mods like `Freeze-Tag` are working as well. All game modes including `Tug-of-War` from Medal of Honor: Spearhead, and `Liberation` from Medal of Honor: Breakthrough are implemented and are working as intended. Mods like `Freeze-Tag` are working as well.
### Single-player
The `training` map can be played from start to end. The single-player campaign is not fully functional, but at least AI can breathe, talk, run, and shoot.
## Features ## Features
- [What's working and what's not](docs/features_implementation.md) - [What's working](docs/features_implementation.md)
- [New features](docs/features.md) - [New features](docs/features.md)
- [Scripting commands](https://htmlpreview.github.io/?https://github.com/openmoh/openmohaa/blob/main/docs/features_g_allclasses.html) - [Scripting commands](https://htmlpreview.github.io/?https://github.com/openmoh/openmohaa/blob/main/docs/features_g_allclasses.html)

2
docs/features.md
View file

@ -8,7 +8,7 @@ A lot of bugs and exploits from MOH:AA were fixed in OpenMoHAA (BOF exploit, gre
- Features from ioquake3 - Features from ioquake3
- IPv6 support (from ioquake3) - IPv6 support (from ioquake3)
- Features from SH 2.15 and BT 2.40 - Features from MOH: Spearhead 2.15 and MOH: Breakthrough 2.40
### Server-side ### Server-side

22
docs/features_implementation.md
View file

@ -2,24 +2,26 @@
## Server ## Server
The server version can be built successfully, but some features are not functional. For example, the Actor system is almost fully implemented, but it is not yet stable. This means that Actor may not work as expected and could cause crashes. The server version can be built successfully. The server and the fgame components are fully implemented, the single-player campaign can be played from start to end in MOH:AA, MOH:SH and MOH:BT. However there could be some minor bugs (and rare crashes), but overall, the game should be playable.
Overall, the server and the fgame components are almost fully implemented, but they may not be completely stable. There could be some minor bugs (and rare crashes), but the game should be playable.
## Client ## Client
The client version of OpenMoHAA has undergone partial implementation, with the cgame module being nearly completed. Credits to the SDK of **Heavy Metal: F.A.K.K. 2** both the cgame and fgame modules. The client version of OpenMoHAA is also fully implemented with a few bugs remaining, and with the cgame module being nearly completed. Credits to the SDK of **Heavy Metal: F.A.K.K. 2** both the cgame and fgame modules.
OpenMoHAA is using OpenAL for the audio.
The current operational status for each component is as follow: The current operational status for each component is as follow:
| Component | Full | Almost | Half | Early | Bad | Not working | Comment | | Component | Full | Almost | Half | Early | Bad | Not working | Comment |
|-------------------------|------|--------|------|-------|-----|-------------|-------------------------------------------------------------------| |-------------------------|------|--------|------|-------|-----|-------------|-------------------------------------------------------------------|
| Audio | | | | | x | | Very basic implementation from Quake III | | Audio | x | | | | | | Full implementation using OpenAL, there may still be some bugs |
| CG Module | | x | | | | | Missing FX, Marks and decals | | CG Module | | x | | | | | Need more fixes for FX, marks and decals |
| Client | x | | | | | | | | Client | x | | | | | | |
| Collision | x | | | | | | | | Collision | x | | | | | | |
| Model/TIKI/Skeletor | x | | | | | | | | Model/TIKI/Skeletor | x | | | | | | |
| Renderer | | x | | | | | Missing ghost, marks, sphere lights, sky portal, sun flare, swipe | | Renderer | x | x | | | | | Missing ghost, sun flare, swipe, some lighting bugs |
| Server | | x | | | | | Probably a few bugs remaining | | Server | x | | | | | | |
| Server module (fgame) | | x | | | | | Actor, and few gameplay bugs | | Server module (fgame) | x | | | | | | There might still be some AI/gameplay bugs |
| UI | | x | | | | | A few bugs to fix | | UI | x | | | | | | |
Full = code is fully working, however it doesn't mean it's bug-free.