chore: add explanation and metadata

Author: BenMcAvoy

LICENSE

@@ -1,6 +1,6 @@
-MIT No Attribution
+MIT
 
-Copyright 2025 ScrappySM
+Copyright 2025 Ben McAvoy, ScrappySM
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this
 software and associated documentation files (the "Software"), to deal in the Software

README.md

@@ -1,16 +1,22 @@
-# Getting started
+# SM-KeyAPI
 
-Welcome to your new DLL mod, you should see you now have a `SM-KeyAPI.sln` file, all the files you see here were generated from the template.
+This mod extends the [SM](https://scrapmechanic.com/) Lua API to allow you to query any key on the keyboard as long as the window is focussed!
 
-## Usage
+## Installation
 
-1. Clone this repository locally
-2. Open the `SM-KeyAPI.sln` file in Visual Studio
-3. Make your changes in `dllmain.cpp`, pressing "Local Windows Debugger" will build and run the game with your mod injected.
-4. Add a description to your mod and adjust any of the necessary fields in [manifest.json](manifest.json)
-5. When you are ready to release your mod, [commit](https://github.com/git-guides/git-commit), [tag](https://www.slingacademy.com/article/working-with-git-tags-a-complete-guide-with-examples/) your commit and push your changes to GitHub.
-6. You can then view the https://github.com/ScrappySM/SM-KeyAPI/releases to see your mod's release page, edit the draft and publish it when you are ready.
+> [!TIP]
+> The recommended method of installing this is [Carbon Launcher](https://github.com/ScrappySM/CarbonLauncher) which is maintained by me and will let you simply press download and launch the game!
 
-## License
+However, there are many other ways. Here's a launcher agnostic way of installing this mod:
+- Go to releases and download the latest `.dll` file.
+- Open a tool like Process Hacker/System Informer and find the process of Scrap Mechanic.
+- Inject the `.dll` file as a module into the process.
 
-You should change the authors or the entire license in the [LICENSE](LICENSE) file to your liking, this template is licensed under The MIT-0 license meaning no attribution is required to use this template - see the [LICENSE](LICENSE) file for details, meaning you can do whatever you want with this template! (yes, you can change the license)
+You can also use a tool like [SM-DLL-Injector](https://github.com/QuestionableM/SM-DLL-Injector) maintained by [QuestionableM](https://github.com/QuestionableM) and will let you simply inject any DLL files in a folder called `DllModules`, you could use this project and put the `.dll` file in the folder and it will automatically inject it for you.
+
+## Explanation/Updating guide
+
+> [!WARNING]
+> This section is for developers and modders who want to understand how the mod works and how to update it.
+
+An explanation of how the mod works and how to update is available in [dllmain](SM-KeyAPI/src/dllmain.cpp).

SM-KeyAPI/src/dllmain.cpp

@@ -1,3 +1,16 @@
+/// How this mod works:
+/// - We hook the loadLuaEnv function, which is called when the game loads the Lua environment.
+/// - We inject a function into the Lua environment that allows us to check the state of a key (implemented in C++ as `keyapi_getkeystate`).
+///
+/// - In the `keyapi_getkeystate` function, we check if the ScrapMechanic window is the active window.
+/// - If it is, we check the state of the key and return it to the Lua environment.
+///
+/// How to update the mod (assumes IDA):
+/// - Go the to names subview (Shift + F4)
+/// - Search for `luaopen_base`
+/// - XRef to the function
+/// - The function you arrive at is the loadLuaEnv function, update the offset in `include/sm/offsets.h`
+
 #define WIN32_LEAN_AND_MEAN
 
 #include <Windows.h>

manifest.json

@@ -5,8 +5,8 @@
   "url": "https://github.com/ScrappySM/SM-KeyAPI",
 
   "authors": [
-    "ScrappySM"
+    "BenMcAvoy"
   ],
 
-  "description": "No description yet, needs to be filled in"
+  "description": "Extends the SM Lua API to query any keyboard input."
 }