Skip to content

eric-levinson/cfb27-lua-hook

Repository files navigation

CFB27 Lua Hook

Offline Lua scripting runtime, Node SDK, and MMC startup tooling for EA SPORTS College Football 27 on PC.

Developer preview 0.2.0-dev.2. The runtime supports one verified game build, is intended only for offline play, and does not include or provide an anticheat bypass.

Project direction

CFB27 Lua Hook is the supported product in this repository:

  • a persistent Lua 5.4 runtime loaded through MMC's existing startup proxy;
  • exact-build and offline write gates;
  • a versioned local named-pipe protocol;
  • the reusable @cfb27/lua-hook CommonJS SDK;
  • the cfb27lua developer CLI;
  • safe examples and runtime research documentation.

The previous save editor, experimental injection hooks, and raw research tools are retained under archive/ for provenance. They are unsupported and excluded from active packages and releases.

CLI surface

cfb27lua install
cfb27lua uninstall
cfb27lua status [--json]
cfb27lua run <script.lua>
cfb27lua eval <source>
cfb27lua events [--after <cursor>]
cfb27lua logs [--follow]
cfb27lua doctor

These commands are implemented in the 0.2.0-dev.2 developer preview. One-shot --json output is a single object; followed logs use JSON Lines.

Start here

Build and test the project, close the game, install the startup hook, then launch through MMC in your offline configuration:

npm ci
npm test
cmake -S native -B native/build-active -A x64
cmake --build native/build-active --config Release
node packages/cli/bin/cfb27lua.cjs install

The CLI requires explicit game, MMC, and artifact paths through flags or the environment variables documented in the getting-started guide.

Safety boundary

  • Close CFB27 before installing or restoring startup files.
  • Writes require an exact recognized executable build.
  • Writes are blocked when a real EA/Javelin anticheat process is present.
  • Memory writes are compare-before-write and readback-verified.
  • Do not disable or allowlist antivirus protection for this project.
  • Keep scripts and integrations offline.

Documentation

Development

Requirements:

  • Windows x64
  • Node.js 20 or later
  • CMake 3.24 or later
  • Visual Studio 2022 C++ build tools
npm install
npm test
npm run check

Native build and release instructions will live under docs/development/.

License

MIT

About

Offline CFB27 Lua hook, scripting SDK, and MMC startup tooling for PC.

Topics

Resources

License

Stars

2 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors