How to install TownTopia
TownTopia is a mod for Minecraft Java Edition 1.21.1. It runs on NeoForge and needs one other mod, GeckoLib. Never installed a mod before? This guide walks you through every click and takes about ten minutes.
The short version
- Minecraft Java 1.21.1 with NeoForge 21.1.238 or newer
- Put the TownTopia jar and GeckoLib 4.8+ (NeoForge, 1.21.1) into your
modsfolder - Give the game at least 4 GB of memory, 6 GB for big villages
- Multiplayer: the server needs the same two jars
Bedrock Edition (consoles, phones, the Windows "Minecraft for Windows" app) can't run Java mods.
-
Open the Minecraft Launcher once
If you've played Minecraft Java on this computer before, skip this step. Otherwise install the official Minecraft Launcher, log in, and close it again. NeoForge installs into the launcher, so the launcher has to exist first.
-
Install NeoForge
- Download the NeoForge installer: Any newer 1.21.1 build from neoforged.net works too: look for a version starting with 21.1.
- Your browser may warn that this kind of file (
.jar) can be harmful. This is NeoForge's official installer, so choose Keep. - Double-click the downloaded file. A window called NeoForge Installer opens.
- Pick Install client, leave the folder as it is, and click OK. Wait until it says Successfully installed client.
Double-clicking doesn't work?
Windows: if nothing happens, or the file opens like a zip (WinRAR, 7-Zip), your computer is missing Java. Install Java 21 from Adoptium (the
.msiinstaller), then double-click the NeoForge file again. You can also right-click it and choose Open with → Java(TM) Platform SE binary or OpenJDK Platform binary.Mac: if it says the file is from an unidentified developer, right-click it, choose Open, then Open again.
-
Set up a TownTopia profile
Open the Minecraft Launcher and go to Installations. NeoForge added one called neoforge. Don't see it? Tick Modded at the top of the list.
We recommend giving TownTopia its own folder and more memory. Hover over the installation, click … and then Edit:
- Name: TownTopia
- Game directory: click Browse and pick a new, empty folder, for example
C:\Games\TownTopia. This keeps TownTopia's mods and worlds apart from your normal game. You can skip this; the game then uses your regular.minecraftfolder. - More options → JVM arguments: the text starts with
-Xmx2G. Change it to-Xmx6G(4G at the very least). That's how much memory the game may use, and villages with lots of villagers need it.
Click Save, then Play. Wait for the title screen and quit the game. This first start creates the
modsfolder. -
Open your mods folder
The easiest way: in Installations, hover over TownTopia and click the folder icon. That opens the game folder; the
modsfolder is inside.Or open it by hand. If you picked your own game directory in step 3, the
modsfolder is in there. Otherwise:Windows
Press Win + R, type
%appdata%\.minecraft\modsand press Enter. The
AppDatafolder is hidden in File Explorer, but this shortcut goes straight there.Mac
In Finder, choose Go → Go to Folder… (Shift + Cmd + G) and enter
~/Library/Application Support/minecraft/modsLinux
Open your file manager at
~/.minecraft/modsFolders starting with a dot are hidden: press Ctrl + H to show them.
-
Add TownTopia and GeckoLib
Download both mods:
On GeckoLib's page, pick the file for NeoForge and 1.21.1, version 4.8 or newer, not the Forge or Fabric one.
Move both
.jarfiles into themodsfolder. Leave them as they are: don't unzip or rename them.Beta tester? The tester pack already has both jars: unzip the pack and copy the two files from its
modsfolder. -
Play
Start the TownTopia installation in the launcher. On the title screen, click Mods: TownTopia and GeckoLib should both be in the list. Create a new world and found your first town.
Updating TownTopia
Delete the old TownTopia jar from your mods folder (early betas were called
dynamicvillages-….jar), then put the new one in. Your worlds stay. Making a copy of the
saves folder first never hurts.
Playing on a server
Joining a server: you need exactly the same TownTopia and GeckoLib versions as the server.
Running your own:
- Run the NeoForge installer again, pick Install server, choose a new empty folder and click OK.
- In that folder, start
run.bat(Windows) orrun.sh(Mac, Linux). It stops right away and asks you to accept Minecraft's EULA: openeula.txt, changeeula=falsetoeula=trueand save. - Put the TownTopia and GeckoLib jars into the server's
modsfolder and start it again.
Something went wrong?
| NeoForge isn't in the launcher | Tick Modded in Installations, or restart the launcher. Still missing? Run the installer again and choose Install client. |
|---|---|
| "Missing GeckoLib" or "requires geckolib" | GeckoLib isn't in the mods folder, or it's the Forge/Fabric version. Get the NeoForge 1.21.1 file. |
| The game crashes straight away | Check you're starting the NeoForge installation, that it's for Minecraft 1.21.1, and that every jar in mods is made for NeoForge 1.21.1. |
| TownTopia isn't in the Mods list | The jar is in a different folder than the game uses. Open the folder from the launcher (step 4) and check it's in there. |
| Lag, stutter or "out of memory" | Give the game more memory with -Xmx6G (step 3). |
| Still stuck? | Ask on our Discord and attach logs\latest.log from your game folder
(and the newest file in crash-reports if the game crashed). |