From 732ff5fef8ca137073f8c252cc54ad356b9ead3d Mon Sep 17 00:00:00 2001 From: modeco80 Date: Sun, 16 Jul 2023 06:20:11 -0400 Subject: [PATCH] cleanup ideas document --- README.md | 7 ++++++- ideas.md | 61 ++++++++++++++++++++++++++++++++++++++----------------- 2 files changed, 48 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 52c5d2c..50f2ac3 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ It provides: - Extensive interoperation with the Wiremod addon - A text editor and assembler suite based on LLVM (for writing bare-metal LCPU programs in assembly) -# Building +# Building Native Module TODO: Steps to build the LCPU native module on Windows and Linux + + +# Installation + +This repository is set up in the exact directory structure a Legacy Addon; therefore once you have built the native module (TODO), adding it to a server should work fine. diff --git a/ideas.md b/ideas.md index ac876fe..db94100 100644 --- a/ideas.md +++ b/ideas.md @@ -1,25 +1,48 @@ -- cpu entities - - controllable paramaters (ram size, ...) - - admin controlled per-user max RAM size (default 32mb) - - possibly override for "respectful" users and admins (admins probably wouldn't even count)? - - admin controlled per-user max lcpu chip count (default 8) - - admins can override/do not count? +# LCPU Idea/Working Model Sheet - - admin controled global (affects all placed lcpus) scheduler timeslice. - - couldn't be faster than tickrate though or we might block source (and.. well, i dont think i have to explain) +This is basically the working ideas for the LCPU project. - - upload a raw binary (or elf? we could probably just imitate a "boot loader" and throw it into memory and move the given register to it?) to execute - - or write assembly/maybe c code for tiny projects +## Core features - - text editor for lcpu projects +- CPU SENTs + - RISC-V rv32ima core + - Would supporting more than one CPU core type be worthwhile? If so, the project is relatively setup for such workflow... + - Controllable paramaters (RAM size, ...) - - some example projects? +## Code upload/project workflow + +- Upload a raw binary to execute, generated from any user tooling + - Yes, this means you can run Linux in GMod. No, I'm not sorry. + - Or even an ELF? Would require less linker hell? + +### Integrated simple project workflow + +- Write assembly/maybe C code using a tiny project system (data for them would go in server data folder ?) + - LLVM assembler is used + - Integrated clang for C code? (if it's not prohibitively expensive) + - In all cases (as/clang), the tools will all be firewalled to the given project data directory. + In the case of clang, an addional path will be allowed (clang freestanding headers), but that's the only exception. - - riscv rv32-ima cpu core - - llvm assembler used in this case - - maybe clang integration? (this might make the addon unwieldly though) +- Text editor used to edit project source files -- wiremod interopability (to obsolete ZCPU at least for my purposes) - - gpio (which uses normal wire stuff) - - console screen - - gpu (if it's not painful to do so)? +- Some example projects? + - I joke about it, but an RTOS would be really nice and a good stress test of the project system (for usage in "real" projects.) + +## Moderation/administration tools +- Admin controlled per-user max RAM size (default 64mb) + - possibly override for "respectful" users and admins (admins probably wouldn't even count)? + +- Admin controlled per-user max LCPU entity count (default 8) + - admins can override/do not count? + +- Admin controled global (affects all placed LCPUs) scheduler timeslice. + - Couldn't be faster than tickrate though or we might block source (and.. well, i dont think i have to explain) + - I decided not to go with the cpu thread stuff just because its annoying, and would require more state tracking. just ticking in lua using `ENTITY:Think` should be more than good enough (even if theres a risk of hitching source, but I don't think it's that big of a problem...) + - Project compilations however will definitely end up in a different thread though. Running them in the engine thread would undoubtably cause issues. + +## Addon interopability + +- Wiremod interopability + - Wiremod GPIO (which uses normal wire stuff) + - Console Screen + - Wire GPU (if it's not painful to do so)?