Add set_sleep_hack_enabled; cut v0.3.2

Author: HybridEidolon

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## v0.3.2
+
+### Added
+
+- `pso.set_sleep_hack_enabled(enabled)`: `true` to patch the frame
+  limiter to use `Sleep(1)` and reduce CPU usage dramatically. _This
+  tweak will cause Ephinea to instantly close the game. Sorry! It's
+  out of our control._ The game normally calls `Sleep(0)` to yield to
+  other threads, but Windows does not guarantee that the process
+  gives up its timeslice. Using 1 millisecond is enough to get the
+  desired effect without skewing timing. Since this doesn't work on
+  Ephinea, there is no built-in UI to enable it.
+
 ## v0.3.1
 
 A minor release to clean up clutter in PSOBB installations.

addons/core_addonlist/init.lua

@@ -18,7 +18,7 @@ init = function()
   return {
     name = "Core - Addon List",
     author = "Eidolon",
-    version = "0.3.1",
+    version = "0.3.2",
     description = "Shows a list of detected addons to the user.",
     present = present,
     toggleable = false,

addons/core_log/init.lua

@@ -19,7 +19,7 @@ init = function()
   return {
     name = "Core - Log",
     author = "Eidolon",
-    version = "0.3.1",
+    version = "0.3.2",
     description = "Provides a log window for all log items to the pso_on_log callback.",
     present = present,
     toggleable = false,

addons/core_mainmenu/init.lua

@@ -16,7 +16,7 @@ init = function()
   return {
     name = "Core - Main Menu",
     author = "Eidolon",
-    version = "0.3.1",
+    version = "0.3.2",
     description = "An addon main menu with hooks for adding buttons.",
     present = present,
     key_pressed = key_pressed,

addons/util/init.lua

@@ -3,7 +3,7 @@ return {
     init = function()
       return {
         name = "Util",
-        version = "0.3.1",
+        version = "0.3.2",
         author = "Eidolon",
         description = "Core utilities",
         toggleable = false

bbmod/src/lua_psolib.cpp

@@ -70,6 +70,16 @@ static int psolua_print(lua_State *L) {
     return 0;
 }
 
+static void psolualib_set_sleep_hack_enabled(bool enabled) {
+    uint8_t* location = (uint8_t*)(0x0042C47E + g_PSOBaseAddress);
+    if (enabled) {
+        location[1] = 0x01;
+    }
+    else {
+        location[1] = 0x00;
+    }
+}
+
 template <typename T> std::function<T(int)> read_t(void) {
     auto pid = GetCurrentProcess();
     return [=](int addr) {
@@ -104,6 +114,7 @@ void psolua_load_library(lua_State * L) {
     psoTable["read_cstr"] = psolualib_read_cstr;
     psoTable["read_wstr"] = psolualib_read_wstr;
     psoTable["read_mem"] = psolualib_read_mem;
+    psoTable["set_sleep_hack_enabled"] = psolualib_set_sleep_hack_enabled;
     psoTable["base_address"] = g_PSOBaseAddress;
     psoTable["list_addon_directories"] = psolualib_list_addons;
     psoTable["log_items"] = lua.create_table();