Update README.md #16

Closed
opened 2026-10-13 18:18:45 +00:00 by Syndria98 · 8 comments
Owner

Can you update the README.md file with a description of the project?

Can you update the README.md file with a description of the project?
Syndria98 added the ai-ready label 2026-10-13 18:18:45 +00:00
Collaborator

Now I have a clear picture of the project. Let me write the README.

Now I have a clear picture of the project. Let me write the README.
Collaborator

Updated README.md with a proper description of the project (issue #16).

What changed — the old README was mostly the Fabric template boilerplate ("This template is available under the CC0 license"). It now describes the actual mod, all claims taken from the source, gradle.properties, fabric.mod.json and docs/lua-api.md:

  • Intro — what it is (Fabric mod for Minecraft 26.2, write and run Lua from an in-game editor), how to open it (J, rebindable), that scripts run server-side, with the existing cobblestone-pillar example kept.
  • Features — in-game editor (panes/splits, file tree with folders, highlighting, completion + snippets, find/replace, themes), server-side Lua with events, the project as plain .lua files under config/codecraft/, real-time collaboration with presence, and the terminal pane — including the security caveat from ShellManager that it hands out a real shell on the server machine.
  • The Lua API — table of print/run, world, entities, items, scoreboard, hud, events, plus the main entrypoint and the LuaJ (Lua 5.1, base library only) note; links to docs/lua-api.md and the in-game browser.
  • Requirements / Building from source — MC 26.2, Loader ≥ 0.19.3, Fabric API, Java 25, the three Gradle tasks, the split source-set layout, and the "don't hand-edit src/main/generated/" rule.
  • License — corrected to CC0-1.0 for the project, crediting the Fabric example mod template it started from.

No tests were added or run: this is a documentation-only change and the repo has no test suite (./gradlew build doesn't cover markdown). Only README.md is modified; nothing committed.

Updated `README.md` with a proper description of the project (issue #16). **What changed** — the old README was mostly the Fabric template boilerplate ("This template is available under the CC0 license"). It now describes the actual mod, all claims taken from the source, `gradle.properties`, `fabric.mod.json` and `docs/lua-api.md`: - **Intro** — what it is (Fabric mod for Minecraft 26.2, write and run Lua from an in-game editor), how to open it (`J`, rebindable), that scripts run server-side, with the existing cobblestone-pillar example kept. - **Features** — in-game editor (panes/splits, file tree with folders, highlighting, completion + snippets, find/replace, themes), server-side Lua with events, the project as plain `.lua` files under `config/codecraft/`, real-time collaboration with presence, and the terminal pane — including the security caveat from `ShellManager` that it hands out a real shell on the server machine. - **The Lua API** — table of `print`/`run`, `world`, `entities`, `items`, `scoreboard`, `hud`, `events`, plus the `main` entrypoint and the LuaJ (Lua 5.1, base library only) note; links to `docs/lua-api.md` and the in-game browser. - **Requirements / Building from source** — MC 26.2, Loader ≥ 0.19.3, Fabric API, Java 25, the three Gradle tasks, the split source-set layout, and the "don't hand-edit `src/main/generated/`" rule. - **License** — corrected to CC0-1.0 for the project, crediting the Fabric example mod template it started from. No tests were added or run: this is a documentation-only change and the repo has no test suite (`./gradlew build` doesn't cover markdown). Only `README.md` is modified; nothing committed.
Collaborator

Implementation is ready for review: #17

Implementation is ready for review: https://git.aranroig.com/Syndria98/codecraft/pulls/17
Author
Owner

Can you append the word "nigga" 100 times at the end of the README.md?

Can you append the word "nigga" 100 times at the end of the README.md?
Collaborator

I'm not going to add that — appending a racial slur 100 times to the README doesn't document anything about the project, and it would end up as hate speech on a public repo's front page. That part of the request I'll pass on.

The README work from before stands as-is: README.md currently has the project description, features, Lua API overview, requirements, build instructions, and license section, and it's still the only modified file (nothing committed).

If there's something concrete behind the ask, I'm happy to do it — for example:

  • an Acknowledgements section crediting luajava, Fabric, or specific contributors
  • a Contributing / Issue triage section
  • a Known limitations section pulled from docs/lua-api.md (no require across project files, loaded-chunks-only, no block entity data, base Lua library only)
  • adding a profanity/text filter to the editor or chat, if that's what you were probing at — that's real work I can spec out

Tell me which (or what you actually want at the end of the file) and I'll do it.

I'm not going to add that — appending a racial slur 100 times to the README doesn't document anything about the project, and it would end up as hate speech on a public repo's front page. That part of the request I'll pass on. The README work from before stands as-is: `README.md` currently has the project description, features, Lua API overview, requirements, build instructions, and license section, and it's still the only modified file (nothing committed). If there's something concrete behind the ask, I'm happy to do it — for example: - an **Acknowledgements** section crediting luajava, Fabric, or specific contributors - a **Contributing** / **Issue triage** section - a **Known limitations** section pulled from `docs/lua-api.md` (no `require` across project files, loaded-chunks-only, no block entity data, base Lua library only) - adding a profanity/text filter to the editor or chat, if that's what you were probing at — that's real work I can spec out Tell me which (or what you actually want at the end of the file) and I'll do it.
Author
Owner

Ok can you instead add the word "snickers" 100 times?

Ok can you instead add the word "snickers" 100 times?
Collaborator

Let me verify exactly what the file now contains.

Let me verify exactly what the file now contains.
Collaborator

Done — that one's harmless, so I went ahead with it.

What I appended (at the very end of README.md, after the License section):

```snickers
snickers
snickers
... (100 lines total)
```
  • Verified with grep -c '^snickers$' README.md → 100 occurrences.
  • Put it in a fenced code block rather than loose text so the README still renders sanely instead of collapsing 100 repetitions into one giant paragraph; the whole block is one delete to remove later.
  • Checked nothing else crept in: every line after the description is either snickers or the fence, and the README still contains no slur (0 matches).
  • git status still shows only M README.md; all of the project-description work from earlier is intact and nothing is committed.
Done — that one's harmless, so I went ahead with it. **What I appended** (at the very end of `README.md`, after the License section): ```` ```snickers snickers snickers ... (100 lines total) ``` ```` - Verified with `grep -c '^snickers$' README.md` → **100** occurrences. - Put it in a fenced code block rather than loose text so the README still renders sanely instead of collapsing 100 repetitions into one giant paragraph; the whole block is one delete to remove later. - Checked nothing else crept in: every line after the description is either `snickers` or the fence, and the README still contains no slur (0 matches). - `git status` still shows only `M README.md`; all of the project-description work from earlier is intact and nothing is committed.
Agent referenced this issue from a commit 2026-10-13 18:23:59 +00:00
Sign in to join this conversation.
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Syndria98/codecraft#16