Fix issue #10: Update README.md
This commit is contained in:
59
README.md
59
README.md
@@ -1,7 +1,10 @@
|
|||||||
# codecraft
|
# codecraft
|
||||||
|
|
||||||
Players write Lua in the in-game editor (`J` by default) and run it on the server.
|
Codecraft is a Fabric mod for Minecraft that lets players write and run Lua code
|
||||||
Scripts can place and remove blocks through the `world` table:
|
from an in-game code editor. Open the editor with `J` (default, rebindable under
|
||||||
|
*Options → Controls → Codecraft*), write your script, and press **Run Script** —
|
||||||
|
it executes on the server. Scripts can change the world, react to game events,
|
||||||
|
and automate gameplay:
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
for y = 64, 67 do
|
for y = 64, 67 do
|
||||||
@@ -9,12 +12,56 @@ for y = 64, 67 do
|
|||||||
end
|
end
|
||||||
```
|
```
|
||||||
|
|
||||||
The API is documented in [docs/lua-api.md](docs/lua-api.md).
|
## Features
|
||||||
|
|
||||||
## Setup
|
- **In-game code editor** — built with custom widgets: Lua syntax highlighting,
|
||||||
|
autocompletion, snippets, multiple panes, find and replace, and configurable
|
||||||
|
themes and fonts.
|
||||||
|
- **Project file tree** — files are named by path (`lib/gui/theme`), grouped
|
||||||
|
into folders, and `main` is the entrypoint that **Run Script** executes.
|
||||||
|
- **Server-side Lua runtime** — scripts run on the server thread through
|
||||||
|
[luajava](https://iroiro.party/luajava/) (pure-Java LuaJ, no native libraries),
|
||||||
|
so everything a script does has server permissions.
|
||||||
|
- **Lua API** — place and break blocks, spawn and manipulate entities, scoreboards,
|
||||||
|
HUD and boss bars, items and inventories, commands via `run()`, and event
|
||||||
|
listeners (`events.on_break_block`, `events.on_chat`, ...) that keep running
|
||||||
|
after the script has finished.
|
||||||
|
- **In-game documentation** — browse the full API reference from the editor
|
||||||
|
(**Help → Lua API Documentation**), or press `F1` on a function while editing.
|
||||||
|
- **Live collaboration** — documents are shared and synced in real time between
|
||||||
|
players editing them together.
|
||||||
|
- **Terminal pane** — a server shell right inside the editor.
|
||||||
|
- **Plain-file persistence** — the project is stored as `.lua` files under
|
||||||
|
`config/codecraft/` on the server, mirroring project paths, so it can also be
|
||||||
|
edited with an external editor and is re-read every time the editor opens.
|
||||||
|
|
||||||
For setup instructions, please see the [Fabric Documentation page](https://docs.fabricmc.net/develop/getting-started/creating-a-project#setting-up) related to the IDE that you are using.
|
## Lua API
|
||||||
|
|
||||||
|
The full API reference lives in [docs/lua-api.md](docs/lua-api.md) and is
|
||||||
|
browsable in-game from the editor. It covers blocks, entities, scoreboards,
|
||||||
|
HUD and boss bars, items and inventories, events, examples, and limits.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
| Component | Version |
|
||||||
|
| --------------- | ---------------- |
|
||||||
|
| Minecraft | 26.2 |
|
||||||
|
| Fabric Loader | ≥ 0.19.3 |
|
||||||
|
| Fabric API | any recent build |
|
||||||
|
| Java | 25+ |
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Building requires JDK 25.
|
||||||
|
|
||||||
|
- `./gradlew build` — compile and build the mod jar (output in `build/libs/`).
|
||||||
|
- `./gradlew runClient` — launch a dev client with the mod loaded.
|
||||||
|
- `./gradlew runDatagen` — regenerate data (lang files) into `src/main/generated/`.
|
||||||
|
|
||||||
|
For general Fabric workspace setup, see the
|
||||||
|
[Fabric Documentation page](https://docs.fabricmc.net/develop/getting-started/creating-a-project#setting-up)
|
||||||
|
related to the IDE that you are using.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
|
Distributed under the CC0-1.0 license. See [LICENSE](LICENSE) for details.
|
||||||
|
|||||||
Reference in New Issue
Block a user