Merge e88ef52d12 into 4592fc42af

Co-authored-by: Gent Semaj <gsemaj@proton.me>

README.md

@@ -28,7 +28,8 @@ OpenFusion is a reverse-engineered server for FusionFall. It primarily targets v
 Instructions for getting the client to run on Linux through Wine can be found [here](https://github.com/OpenFusionProject/OpenFusion/wiki/Running-the-game-client-on-Linux).
 
 ### Hosting a server
-1. Grab `OpenFusionServer-1.5-Original.zip` or `OpenFusionServer-1.5-Academy.zip` from [here](https://github.com/OpenFusionProject/OpenFusion/releases/tag/1.5).
+
+1. Grab `OpenFusionServer-1.5-original.zip` or `OpenFusionServer-1.5-academy.zip` from [here](https://github.com/OpenFusionProject/OpenFusion/releases/tag/1.5).
 2. Extract it to a folder of your choice, then run `winfusion.exe` (Windows) or `fusion` (Linux) to start the server.
 3. Add a new server to the client's list:
     1. For Description, enter anything you want. This is what will show up in the server list.
@@ -53,7 +54,10 @@ FusionFall consists of the following components:
 
 The original game made use of the player's actual web browser to launch the game, but since then the NPAPI plugin interface the game relied on has been deprecated and is no longer available in most modern browsers. Both Retro and OpenFusion get around this issue by distributing an older version of Electron, a software package that is essentially a specialized web browser.
 
-The browser/Electron client opens a web page with an `<embed>` tag of the appropriate MIME type, where the `src` param is the address of the game's `.unity3d` entrypoint. This triggers the browser to load an NPAPI plugin that handles said MIME type, in this case the Unity Web Player.
+The browser/Electron client opens a web page with an `<embed>` tag of MIME type `application/vnd.unity`, where the `src` param is the address of the game's `.unity3d` entrypoint.
+
+This triggers the browser to load an NPAPI plugin that handles this MIME type, the Unity Web Player, which the browser looks for in `C:\Users\%USERNAME%\AppData\LocalLow\Unity\WebPlayer`.
+The Web Player was previously copied there by `installUnity.bat`.
 
 Note that the version of the web player distributed with OpenFusion expects a standard `UnityWeb` magic number for all assets, instead of Retro's modified `streamed` magic number.
 This will potentially become relevant later, as people start experimenting and mixing and matching versions.
@@ -62,7 +66,7 @@ The web player will execute the game code, which will request the following file
 
 `/assetInfo.php` contains the address from which to fetch the rest of the game's assets (the "dongresources").
 Normally those would be hosted on the same web server as the gateway, but the OpenFusion distribution (in it's default configuration) doesn't use a web server at all!
-It instead loads the web pages locally using the `file://` schema, and fetches the game's assets from a standard web server.
+It loads the web pages locally using the `file://` schema, and fetches the game's assets from Turner's CDN (which is still hosting them to this day!).
 
 `/loginInfo.php` contains the IP:port pair of the FusionFall login server, which the client will connect to. This login server drives the client while it's in the Character Selection menu, as well as Character Creation and the Tutorial.
 
@@ -98,13 +102,26 @@ If you'd like to contribute to this project, please read [CONTRIBUTING.md](CONTR
 ## Gameplay
 
 The goal of the project is to faithfully recreate the game as it was at the time of the targeted build.
-While most features are implemented and the game is playable start to finish, there may be missing functionality or bugs present.
+The server is not yet complete, however, and some functionality is still missing.
 
-Depending on the server configuration, you'll have access to certain commands.
+Because the server is still in development, ordinary players are allowed access to a few admin commands:
 
-For the public servers: Original has item spawning, the ability to set player speed/jump height, and teleportation enabled (default account level 50).
-Meanwhile the Academy server is more meant for legitimate playthroughs (default account level 99).
+![](res/sane_upsell.png)
 
-When hosting a local server, you will have access to all commands by default (account level 1).
+### Movement commands
+* A `/speed` of around 2400 or 3000 is nice.
+* A `/jump` of about 50 will send you soaring
+* [This map](res/dong_number_map.png) (credit to Danny O) is useful for `/warp` coordinates.
+* `/goto` is useful for more precise teleportation (ie. for getting into Infected Zones, etc.).
 
-For a list of available commands, see [this wiki page](https://github.com/OpenFusionProject/OpenFusion/wiki/Ingame-Command-list).
+### Item commands
+* `/itemN [type] [itemId] [amount]`
+  (Refer to the [item list](https://docs.google.com/spreadsheets/d/1mpoJ9iTHl_xLI4wQ_9UvIDYNcsDYscdkyaGizs43TCg/))
+
+### Nano commands
+* `/nano [id] (1-36)`
+* `/nano_equip [id] (1-36) [slot] (0-2)`
+* `/nano_unequip [slot] (0-2)`
+* `/nano_active [slot] (0-2)`
+
+### A full list of commands can be found [here](https://github.com/OpenFusionProject/OpenFusion/wiki/Ingame-Command-list).

config.ini

@@ -51,6 +51,11 @@ motd=Welcome to OpenFusion!
 # and pre-Academy builds must *not* contain it.
 #enabledpatches=1013
 
+# Use Original FusionFall's racing score and reward calculation?
+# Set false to use Retro's calculation, make sure you have the correct
+# patch(es) loaded.
+#ogracingscores=true
+
 # xdt json filename
 #xdtdata=xdt.json
 # NPC json filename

src/Combat.cpp

@@ -365,7 +365,7 @@ static std::pair<int,int> getDamage(int attackPower, int defensePower, bool shou
     return ret;
 }
 
-static bool checkRapidFire(CNSocket *sock, int targetCount, bool allowManyTargets) {
+static bool checkRapidFire(CNSocket *sock, int targetCount) {
     Player *plr = PlayerManager::getPlayer(sock);
     time_t currTime = getTime();
 
@@ -377,7 +377,7 @@ static bool checkRapidFire(CNSocket *sock, int targetCount, bool allowManyTarget
     plr->lastShot = currTime;
 
     // 3+ targets should never be possible
-    if (!allowManyTargets && targetCount > 3)
+    if (targetCount > 3)
         plr->suspicionRating += 10001;
 
     // kill the socket when the player is too suspicious
@@ -396,7 +396,7 @@ static void pcAttackNpcs(CNSocket *sock, CNPacketData *data) {
     auto targets = (int32_t*)data->trailers;
 
     // kick the player if firing too rapidly
-    if (settings::ANTICHEAT && checkRapidFire(sock, pkt->iNPCCnt, false))
+    if (settings::ANTICHEAT && checkRapidFire(sock, pkt->iNPCCnt))
         return;
 
     /*
@@ -837,10 +837,6 @@ static void projectileHit(CNSocket* sock, CNPacketData* data) {
         return;
     }
 
-    // kick the player if firing too rapidly
-    if (settings::ANTICHEAT && checkRapidFire(sock, pkt->iTargetCnt, true))
-        return;
-
     /*
      * initialize response struct
      * rocket style hit doesn't work properly, so we're always sending this one

src/Racing.cpp

@@ -105,12 +105,18 @@ static void racingEnd(CNSocket* sock, CNPacketData* data) {
     uint64_t now = getTime() / 1000;
     int timeDiff = now - epRace.startTime;
     int podsCollected = epRace.collectedRings.size();
+    int score = 0, fm = 0;
 
-    int score = std::min(epInfo.maxScore, (int)std::exp(
-        (epInfo.podFactor * podsCollected) / epInfo.maxPods
-        - (epInfo.timeFactor * timeDiff) / epInfo.maxTime
-        + epInfo.scaleFactor));
-    int fm = (1.0 + std::exp(epInfo.scaleFactor - 1.0) * epInfo.podFactor * podsCollected) / epInfo.maxPods;
+    if (settings::OGRACINGSCORES) {
+        score = std::min(epInfo.maxScore, (int)std::exp(
+            (epInfo.podFactor * podsCollected) / epInfo.maxPods
+            - (epInfo.timeFactor * timeDiff) / epInfo.maxTime
+            + epInfo.scaleFactor));
+        fm = (1.0 + std::exp(epInfo.scaleFactor - 1.0) * epInfo.podFactor * podsCollected) / epInfo.maxPods;
+    } else {
+        score = std::max(0, 500 * podsCollected - 10 * timeDiff);
+        fm = score * plr->level * (1.0f / 36) * 0.3f;
+    }
 
     // we submit the ranking first...
     Database::RaceRanking postRanking = {};

src/Racing.hpp

@@ -9,9 +9,9 @@
 struct EPInfo {
     // available through XDT (maxScore may be updated by drops)
     int zoneX, zoneY, EPID, maxScore;
-    // available through drops
-    int maxTime, maxPods;
-    double scaleFactor, podFactor, timeFactor;
+    // (maybe) available through drops
+    int maxTime = 0, maxPods = 0;
+    double scaleFactor = 0.0, podFactor = 0.0, timeFactor = 0.0;
 };
 
 struct EPRace {

src/TableData.cpp

@@ -586,15 +586,17 @@ static void loadDrops(json& dropData) {
 
             EPInfo& epInfo = Racing::EPData[EPMap];
 
-            // max score is specified in the XDT, but can be updated if specified in the drops JSON
-            epInfo.maxScore = (int)race["ScoreCap"];
-            // time limit and total pods are not stored in the XDT, so we include it in the drops JSON
+            // time limit isn't stored in the XDT, so we include it in the reward table instead
             epInfo.maxTime = (int)race["TimeLimit"];
-            epInfo.maxPods = (int)race["TotalPods"];
-            // IZ-specific calculated constants included in the drops JSON
-            epInfo.scaleFactor = (double)race["ScaleFactor"];
-            epInfo.podFactor = (double)race["PodFactor"];
-            epInfo.timeFactor = (double)race["TimeFactor"];
+
+            // the following has to be present based on the score calculation method
+            if (settings::OGRACINGSCORES) {
+                epInfo.maxScore = (int)race["ScoreCap"];
+                epInfo.maxPods = (int)race["TotalPods"];
+                epInfo.scaleFactor = (double)race["ScaleFactor"];
+                epInfo.podFactor = (double)race["PodFactor"];
+                epInfo.timeFactor = (double)race["TimeFactor"];
+            }
 
             // score cutoffs
             std::vector<int> rankScores;

src/main.cpp

@@ -64,7 +64,7 @@ void terminate(int arg) {
 }
 
 #ifdef _WIN32
-static BOOL WINAPI winTerminate(DWORD arg) {
+static BOOL winTerminate(DWORD arg) {
     terminate(0);
     return FALSE;
 }

src/settings.cpp

@@ -67,6 +67,9 @@ int settings::MONITORINTERVAL = 5000;
 // event mode settings
 int settings::EVENTMODE = 0;
 
+// racing score mode
+bool settings::OGRACINGSCORES = true;
+
 void settings::init() {
     INIReader reader("config.ini");
 
@@ -111,6 +114,7 @@ void settings::init() {
     EVENTMODE = reader.GetInteger("shard", "eventmode", EVENTMODE);
     DISABLEFIRSTUSEFLAG = reader.GetBoolean("shard", "disablefirstuseflag", DISABLEFIRSTUSEFLAG);
     ANTICHEAT = reader.GetBoolean("shard", "anticheat", ANTICHEAT);
+    OGRACINGSCORES = reader.GetBoolean("shard", "ogracingscores", OGRACINGSCORES);
     MONITORENABLED = reader.GetBoolean("monitor", "enabled", MONITORENABLED);
     MONITORPORT = reader.GetInteger("monitor", "port", MONITORPORT);
     MONITORINTERVAL = reader.GetInteger("monitor", "interval", MONITORINTERVAL);

src/settings.hpp

@@ -38,6 +38,7 @@ namespace settings {
     extern int MONITORPORT;
     extern int MONITORINTERVAL;
     extern bool DISABLEFIRSTUSEFLAG;
+    extern bool OGRACINGSCORES;
 
     void init();
 }