modeco80
/
gmod-lcpu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
LCPU - a alternative CPU addon for Garry's Mod
48 Commits 1 Branch 0 Tags 382 KiB
C++ 83.2%
Lua 8.1%
CMake 4.5%
C 2.7%
Shell 1.3%
Other 0.2%
Go to file
Lily Tsuru 4538cd182d lcpu: more cleanup. this is the last one I promise, I need sleep 2023-07-27 07:21:04 -04:00
data begin actually setting up the repository as a GMod addon.. 2023-07-16 06:05:19 -04:00
lua lcpu: Cleanup, and begin the implementation of a new system for Lua binding 2023-07-27 07:16:39 -04:00
native lcpu: more cleanup. this is the last one I promise, I need sleep 2023-07-27 07:21:04 -04:00
test-gmod lcpu: Lua devices now work!! 2023-07-27 06:03:28 -04:00
.clang-format riscv: implement syscon + system hooks 2023-07-24 01:56:50 -04:00
.editorconfig init 2023-07-16 01:58:32 -04:00
.gitignore test lua binding things 2023-07-24 06:50:18 -04:00
.gitmodules RamDevice is public 2023-07-18 02:05:39 -04:00
LICENSE revert loggingsystem usage until I feel safe requiring x64 gmod 2023-07-18 23:33:30 -04:00
README.md update readme to reflect move to cwgit 2023-07-23 05:22:32 -04:00
build_module.sh test lua binding things 2023-07-24 06:50:18 -04:00
ideas.md revert loggingsystem usage until I feel safe requiring x64 gmod 2023-07-18 23:33:30 -04:00

README.md

LCPU

LCPU is an alternative CPU core addon for Garry's Mod and Wiremod.

It provides:

  • A standard RISC-V architechure (rv32ima) CPU core, implemented in native code
    • I know, but it wouldn't particularly be very good if I managed to implement it in Lua (that and the more reasons to not use Lua for a part of this codebase, the better...)
  • Interoperation with the Wiremod addon (and addons which implement Wiremod integration)

This addon (for now) works with both the non-beta branch and the x86-64 beta branches of GMod.

Note that the GitHub mirror is provided only for convinence, and is not used for active development. See this link for the actual development repository.

Installation

This repository is set up to be a Filesystem Addon; therefore, workflows which clone repositories from Git and put them in addons/ should be able to work with the LCPU addon just fine.

Preliminary installation steps:

garrysmod/addons$ git clone --recursive https://git.crustywindo.ws/modeco80/gmod-lcpu.git lcpu
garrysmod/addons$ cd lcpu

# Build the LCPU native module. These steps build the linux64 version of the module
# on linux; you'll need to alter it if you want to build for 32-bit.
garrysmod/addons/lcpu$ cmake -Wno-dev -GNinja -S native -B build \
	-DCMAKE_BUILD_TYPE=Release
garrysmod/addons/lcpu$ ninja -C build

# Install the native module (Linux)
# For Windows you can do the same thing, just replace this
# with how you'd do it in batch (or use Explorer, I'm not your dad)
garrysmod/addons/lcpu$ [[ ! -d '../../lua/bin']] && mkdir -p ../../lua/bin && cp build/projects/lcpu/*.dll ../../lua/bin

# Tada!

On Linux you can alternatively use the ./build_module.sh script that will do all the build and installation steps automatically, once cloning the repository in the garrysmod/addons folder.

Windows building is currently untested; I see no reason why it wouldn't work but it is not a platform I will focus on specifically.

Special Thanks

CNLohr - I may not like the mini-rv32ima code that much, but it did still help a lot (and my emulation core library is based off it, with tons of refactoring and a C++ rewrite to boot.), so thanks for creating the project.