Skip to content

techmc-wiki/gtmc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,848 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Graduate Texts in MinecraftGraduate Texts in Minecraft

Graduate Texts in Minecraft

A community-written online textbook on Technical Minecraft.

Read tutorials, mechanics deep-dives, and source-code walkthroughs. All openly written and reviewed.

Website Ask DeepWiki Next.js React TypeScript License Articles

Visit the Site · Browse Raw Articles · More GTMC Projects

English | 汉语


About

Graduate Texts in Minecraft (GTMC) is an open knowledge base for the technical side of Minecraft — redstone, game mechanics, and engine internals. Anyone can read it, and the community writes and reviews it together.

You'll find three kinds of articles:

  • Tutorials — step-by-step walkthroughs for builders.
  • Explanations — how in-game mechanics actually work, from first principles.
  • Code Analysis — annotated readings of the game's source.

They span the whole stack of technical play: production builds like tree farms, mechanical redstone and component behavior, slime-tech flying machines, and the timing and wiring that hold them together. On the engine side, articles dig into micro-timing, block updates and update order, chunk loading and loading tickets, and entity AI and movement — backed by source reading where it matters. Tooling chapters cover the staples of a technical setup (Carpet, Litematica, and the masa suite), so newcomers and veterans both have a way in.

The fastest way to start is to visit the site. Want to contribute? You can draft and submit articles right from the site.

Note

This repo is the website. Articles live in their own repo and are pulled in as a submodule. Other GTMC projects are at github.com/orgs/gtmc-dev.

Running it locally

Next.js, React, TypeScript, Tailwind CSS, Prisma, Supabase, Vercel

git clone https://github.com/techmc-wiki/gtmc.git
cd gtmc
vp install              # uses the pinned pnpm version
cp .env.example .env    # add GitHub OAuth, database URL, etc.
pnpm dev                # http://localhost:3000

Common scripts:

pnpm dev          # Start the dev server
pnpm build        # Full production build (content + Next.js)
vp check          # Check formatting and linting
vp test run       # Run the Vitest suite once
pnpm typecheck    # Run the Next.js-aware TypeScript check

In development, the first localhost request automatically signs in as the local admin fixture (debug@gtmc.local) and seeds that user in DATABASE_URL. Set GTMC_DEV_FIXTURE_AUTH=0 before starting pnpm dev to use the real GitHub sign-in flow instead.

Tip

pnpm build runs in two phases: build:content generates static artifacts (article manifest, glossary, rendered content, offline PDF), then build:next builds the site from them. Run them separately when you only need one. Vite+ supplements the Next.js toolchain; vp dev and vp build are Vite commands and are not used by this project.


Code: Apache-2.0 · Articles: CC BY-NC-SA 4.0

About

Graduate Texts in Minecraft - The online Minecraft textbook

Resources

License

Contributing

Stars

60 stars

Watchers

4 watching

Forks

Contributors