BetaMoon - A Lua Scripting Engine for Beta 1.7.3

BetaMoon needs a bit more setup during installation than most mods, so please follow the Installation Instructions!

BetaMoon is a Lua scripting engine on top of Risugami's ModLoader and MinecraftForge for MC b1.7.3.

The goal is to provide an easy-to-use scripting layer for MC b1.7.3 to create custom content or functionality for the game, similar to KubeJS with Lua instead of JS.

For simpler modifications, this makes the modding process much easier: Instead of setting up a modding environment, dealing with obfuscation and compile errors, etc., you can just write your Lua script and start Minecraft!

If something fails, BetaMoon will report it to you while trying to prevent Minecraft from crashing.

But be aware: BetaMoon is still being developed and can't offer everything you may want to add to Minecraft. Furthermore, multiplayer support is currently very limited, and it's not advised to install BetaMoon on a server!

You can find a list of awesome BetaMoon Mods here.

Please Note

BetaMoon is a scripting engine and does not add gameplay content itself. Content has to be added using Lua scripts that use the provided Lua API, as explained in the Wiki.

Pre-Release Disclaimer

This mod is designed with easy expandability and backwards compatibility in mind. However, while BetaMoon is in its pre-release stage (versions <1.0.0), breaking changes are sometimes unavoidable. They may also happen between major versions.

Please be aware of that, keep backups of your worlds and always look at the changelog when updating!

Features

Currently, BetaMoon offers the following features:

• Custom Blocks
• Custom Items
• Custom Tools, Armor and their Materials
• Custom Recipes and Recipe Types
• Interactable Items and Blocks
• Custom Biomes, Trees and Structures
• Ore Generation
• Custom Terrain Generators and World Generation Settings
• Custom Dimensions and Teleportation
• Custom Fluids
• Custom Particles
• Overriding existing Blocks, Items, etc.
• Custom Tile Entities, Containers and Block GUIs
• Resizable GUI Elements and Animated Transitions
• Multiblock Structures
• Logical Networks and Capabilities
• Creating Event Handlers and Custom Hotkeys
• Sending Chat Messages
• Custom Entities
• Modifying Player and Entity Movement
• Custom Models and Animations using supported Bedrock/GeckoLib-style JSON formats
• Custom Sounds and Atmosphere Effects

For a full overview and documentation, visit the Wiki!

Installation

Requirements and Installation

• Java 8
• Minecraft Beta 1.7.3 (installation via MultiMC or a similar launcher is recommended)
• Risugami's ModLoader for Beta 1.7.3
• MinecraftForge 1.0.6 for Beta 1.7.3
• BetaMoon installed as a mod and enabled as a Java agent

For installation instructions, please refer to the Readme sections.

Installing Scripts

BetaMoon automatically creates a betamoon/scripts directory inside your .minecraft folder, or your instance's .minecraft folder if you use MultiMC/Prism. You can add new scripts by dropping them in there.

Make sure to include any required assets and keep their folder structure intact. Packaged mods can be installed as complete folders or ZIP files.

BetaMoon logs errors it encounters when loading scripts and gives you a popup listing which scripts failed to load. Errors and warnings are also available in the Scripts screen.

You can reload scripts from that screen. Some changes, like changing container layouts, require restarting Minecraft.

Look at the GitHub page and Wiki for more information on installing scripts or developing your own!

If you use VS Code, there is also a BetaMoon API addon for code completion, documentation and type checking.

Help and Feedback

If you have trouble installing BetaMoon, please check the installation instructions and Troubleshooting page first.

If you're still stuck or have questions about using BetaMoon, feel free to contact me directly or ask in GitHub Discussions. Questions about writing scripts are welcome there too!

Reporting Bugs

Please report bugs through GitHub Issues. If possible, include:

• Your BetaMoon version
• What happened and what you expected to happen
• Steps to reproduce the problem
• Other mods and BetaMoon scripts you have installed
• Any relevant error messages or screenshots

You can save a diagnostic report from Scripts → Debug → Full script report and attach it to your issue. This includes script errors and useful information about your setup.

If Minecraft won't start, attach the launcher log instead. If the problem happens with a script you wrote, please include the script or a small example that reproduces it.

Suggesting Features

You can also use GitHub Issues to suggest future features. Please explain what you want to create or change and what you're currently missing in the API.