Repo ↗ · Source README ↗ · Markdown & license bundle

Image reference (original game): Garry’s Mod · original-game artwork, provided by IGDB. Image rights remain with their respective owners. This illustrates the referenced original game, not the actual visuals of this rewrite or mod.

Source maintainer: PeytonWDYM · Revision: a4a71bc2fb3c · Catalogued: 2026-10-12

Source license: MIT · LICENSE · Article: Source README (format adapted)

The source README follows, with formatting adapted for this site and images replaced by source links. Feature, completion and testing claims belong to its authors and have not been independently playtested here. The Traditional Chinese translation was prepared with AI assistance.


GarryCraft

Minecraft gameplay inside Garry’s Mod. Minecraft handles movement, blocks, inventory, and mobs. Garry’s Mod supplies maps, props, NPCs, and rendering.

README image:Minecraft player with an elytra above a Garry’s Mod beach

Install V1

Windows x64 and 64-bit Garry’s Mod are required. Single-player only.
Own Garry’s Mod and Minecraft Java Edition. Setup downloads Minecraft Java 26.3, Fabric, and a private Java 25 runtime.
You do not need build tools, a separate Java installation, or PowerShell 7.

  1. In Steam, select Garry’s Mod > Properties > Betas > x86-64.
  2. Wait for the update, then close Garry’s Mod.
  3. Download GarryCraft-1.0.4-windows-x64.zip from the latest release. Use this asset, not the Source code archives.
  4. Extract the entire ZIP and open Install.cmd.
  5. Open the printed Play.cmd path and select Sandbox > gm_construct > Single Player.

Setup finds Garry’s Mod in your Steam libraries and installs GarryCraft.
If asked for the game folder, use Steam’s Properties > Installed Files > Browse and paste that path.

Minecraft gets its own installation and required mods at %LOCALAPPDATA%\GarryCraft\player.
Your existing Minecraft installation stays separate. Your enabled GMod addons load as usual.

Setup stops if your GMod engine build is unsupported. Steam updates can require a new GarryCraft release.
See installation help for fixes, logs, and manual installation.

Open Play.cmd to start a GarryCraft session. Minecraft starts when you load a single-player map.
Launch GMod through Steam for normal play. GarryCraft’s bridge code and native modules stay inactive in that session.
Each GarryCraft map keeps a separate Minecraft world.
Use Spawn Menu > Utilities > GarryCraft, or garrycraft_menu, to enable or disable the bridge.

Open Uninstall.cmd to remove GarryCraft. It preserves worlds and settings by default.
Use Uninstall.cmd -Purge for a complete reset, including those worlds and settings.

From a source checkout, Install.cmd downloads and runs the matching compiled release installer automatically.
If release contains the matching ZIP and checksum, setup verifies and uses that local package.

Current limits

V1 targets local Windows x64 Sandbox play. Other maps, game modes, and addons need separate compatibility tests.
Physics and rendering have known limits. Source lighting does not reproduce Minecraft lighting.
Read feature coverage and architecture before reporting compatibility or complete physics parity.

Development

Read AGENTS.md for contributor and coding-agent instructions.
Development requires JDK 25, PowerShell 7, Visual Studio 2022 C++ tools, and CMake.
Use a separate GMod installation with a .garrycraft-lab marker.

.\tools\Build.ps1
.\tools\Setup-Lab.ps1 -LabPath "$env:LOCALAPPDATA\GarryCraft\gmod-lab"

Keep generated game files, account data, logs, and test worlds outside tracked source.
See release packaging and installer scenarios.

The bridge builds on SkyCraft.
Protocol · Change log · Third-party notices


License and provenance

The README and its translation retain MIT terms. Changes comprise translation, links and formatting. Editable Markdown, the original README, LICENSE and NOTICE files are included in the linked bundle. This grants no rights to the original games, their assets or trademarks.

LICENSE

MIT License

Copyright (c) 2026 Peyton

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

THIRD_PARTY_NOTICES

# Third-party notices

## SkyCraft

The collision, input, camera, water, combat, and renderer capture ports derive from chasmlol/SkyCraft.
https://github.com/chasmlol/SkyCraft

MIT License

Copyright (c) 2026 chasmlol

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


## garrysmod_common

The native build uses danielga/garrysmod_common headers.
https://github.com/danielga/garrysmod_common

garrysmod_common
A repository of common bits for compilation projects based on Garry's
Mod.
-----------------------------------------------------------------------
Copyright (c) 2015-2023, Daniel Almeida
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


## Gradle wrapper

The Gradle wrapper uses the Apache License, Version 2.0.
https://github.com/gradle/gradle/blob/master/LICENSE

## Game assets

The physics gun uses model, material, and animation files from the user's installed Garry's Mod at runtime.
This repository does not distribute Valve game assets. Minecraft textures and player skins also remain local runtime data.
The Physics Gun inventory icon is an original project asset.

THIRD_PARTY_NOTICES.md

# Third-party notices

## SkyCraft

The collision, input, camera, water, combat, and renderer capture ports derive from chasmlol/SkyCraft.
https://github.com/chasmlol/SkyCraft

MIT License

Copyright (c) 2026 chasmlol

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


## garrysmod_common

The native build uses danielga/garrysmod_common headers.
https://github.com/danielga/garrysmod_common

garrysmod_common
A repository of common bits for compilation projects based on Garry's
Mod.
-----------------------------------------------------------------------
Copyright (c) 2015-2023, Daniel Almeida
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


## Gradle wrapper

The Gradle wrapper uses the Apache License, Version 2.0.
https://github.com/gradle/gradle/blob/master/LICENSE

## Game assets

The physics gun uses model, material, and animation files from the user's installed Garry's Mod at runtime.
This repository does not distribute Valve game assets. Minecraft textures and player skins also remain local runtime data.
The Physics Gun inventory icon is an original project asset.