{"id":24583717,"url":"https://github.com/toebeann/snapbuilder","last_synced_at":"2025-04-28T10:39:11.878Z","repository":{"id":50757854,"uuid":"246427974","full_name":"toebeann/SnapBuilder","owner":"toebeann","description":"Snap-to-Grid in Subnautica!","archived":false,"fork":false,"pushed_at":"2023-06-02T23:48:04.000Z","size":456,"stargazers_count":6,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T08:41:33.616Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.nexusmods.com/subnautica/mods/427","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/toebeann.png","metadata":{"funding":{"github":["toebeann"],"ko_fi":"toebean_","custom":["https://paypal.me/tobeyblaber"]},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-10T23:13:40.000Z","updated_at":"2025-01-20T15:16:44.000Z","dependencies_parsed_at":"2023-02-10T00:00:55.353Z","dependency_job_id":null,"html_url":"https://github.com/toebeann/SnapBuilder","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2FSnapBuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2FSnapBuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2FSnapBuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/toebeann%2FSnapBuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/toebeann","download_url":"https://codeload.github.com/toebeann/SnapBuilder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251296657,"owners_count":21566650,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-24T04:48:36.427Z","updated_at":"2025-04-28T10:39:11.858Z","avatar_url":"https://github.com/toebeann.png","language":"C#","funding_links":["https://github.com/sponsors/toebeann","https://ko-fi.com/toebean_","https://paypal.me/tobeyblaber"],"categories":[],"sub_categories":[],"readme":"![SnapBuilder - Snap-to-Grid for Subnautica!](https://staticdelivery.nexusmods.com/mods/1155/images/427/427-1671005676-1635506048.png)\n\n# SnapBuilder - Snap-to-Grid for Subnautica \u0026 Subnautica: Below Zero!\n\n## What is this?\n\nSnapBuilder is **the** snap-to-grid mod for Subnautica \u0026 Subnautica: Below Zero you've been dreaming of!\n\n### Features\n\n-   Snap-to-grid enabled for all items! (Doesn't apply to rooms as they already snap together)\n-   [When aiming at a wall or the side of an item, will automatically snap the item into position!](https://i.imgur.com/kY9Xefg.mp4)\n-   [Automatically upgrades inaccurate hitboxes so that items can properly snap to them!](https://i.imgur.com/D8DycbH.mp4) (Mostly only applies to Subnautica: Below Zero)\n-   The range for building can be extended and customised! (On the legacy branch of Subnautica, this only applies to items, not rooms)\n-   All keybinds and parameters can be tweaked in-game with [Configuration Manager](https://www.nexusmods.com/subnautica/mods/1112/)! (Simply press F5 to open the configuration window)\n-   Fully compatible with the QMods and the legacy branch of Subnautica!\n-   Fully compatible with [Decorations Mod](https://www.nexusmods.com/subnautica/mods/102)!\n\n![Configuring SnapBuilder](https://staticdelivery.nexusmods.com/mods/1155/images/427/427-1671005686-1718616155.png)\n\n## Installation\n\n### Prerequisites (install these first)\n\n#### **Required**\n\n-   The relevant BepInEx pack for your game:\n    -   [**BepInEx pack for Subnautica**](https://www.nexusmods.com/subnautica/mods/1108)\n    -   [**BepInEx pack for Subnautica: Below Zero**](https://www.nexusmods.com/subnauticabelowzero/mods/344)\n\n#### Highly recommended\n\n-   [**Vortex Mod Manager**](https://www.nexusmods.com/about/vortex/) (Windows only) - Makes installing mods a breeze.\n-   [**BepInEx Tweaks**](https://www.nexusmods.com/subnautica/mods/1104) - Without this, SnapBuilder and many other BepInEx plugins will be disabled whenever you back out to the main menu and will not work again until you restart the game.\n-   [**Configuration Manager**](https://www.nexusmods.com/subnautica/mods/1112) - Allows you to configure your settings for this and many other BepInEx plugins in-game.\n\n### Installating SnapBuilder\n\n#### Automatic (Windows only)\n\n1. Get [Vortex Mod Manager](https://www.nexusmods.com/about/vortex/)\n2. Click the `Vortex` button at the top of the relevant Nexus Mods page for this mod to install:\n    - [SnapBuilder for Subnautica](https://www.nexusmods.com/subnautica/mods/427)\n    - [SnapBuilder for Subnautica: Below zero](https://www.nexusmods.com/subnauticabelowzero/mods/57)\n\n#### Manual\n\n1. Click the `Manual Download` button under the main file of the Files tab of the relevant Nexus Mods page to download:\n    - [SnapBuilder for Subnautica](https://www.nexusmods.com/subnautica/mods/427?tab=files)\n    - [SnapBuilder for Subnautica: Below zero](https://www.nexusmods.com/subnauticabelowzero/mods/57?tab=files)\n2. Extract the contents of the archive into the `[game dir]\\BepInEx` folder\n\n## Default controls\n\nThe following controls are entirely configurable in-game with [Configuration Manager](https://www.nexusmods.com/subnautica/mods/1112/). Simply press F5 to open the configuration window.\n\n-   Toggle snap-to-grid/freehand placement: `middle mouse`\n-   Toggle fine grid snapping: `left ctrl`\n-   Toggle fine rotation snapping: `left alt`\n-   Toggle detailed colliders: `f`\n-   Toggle extended build range: `b`\n-   Increase extended build range: `mouse4`\n-   Decresae extended build range: `mouse3`\n-   Reset extended build range: `mouse4` + `mouse3`\n\n## Need help?\n\nMost issues are resolved by carefully re-reading the installation instructions or stickies at the top of the Posts tab on the relevant Nexus Mods page ([Subnautica](https://www.nexusmods.com/subnautica/mods/427?tab=posts), [Below Zero](https://www.nexusmods.com/subnauticabelowzero/mods/57?tab=posts)), but if you have stumbled on a bug, please file a bug report on the Bugs tab ([Subnautica](https://www.nexusmods.com/subnautica/mods/427?tab=bugs), [Below Zero](https://www.nexusmods.com/subnauticabelowzero/mods/57?tab=bugs)) with as much information as possible to help me find the cause and get it squashed in an update.\n\n## I'm a dev, how do I make my mod compatible?\n\nBy default, most items added to the game by other mods should work just fine with SnapBuilder assuming they also work fine in-game. For the edge cases where they do not and SnapBuilder does not understand which way to rotate your items by default, it is easy to make your items compatible without a dependency on SnapBuilder.\n\nOn your prefab's model `GameObject`, simply add a child `GameObject` named `SnapBuilder`. Whatever you set the `localRotation` and `localPosition` of this `GameObject` to, SnapBuilder will treat these as the default transformations for the item.\n\nThe `GameObject` named `SnapBuilder` must be the direct child of the `GameObject` located at `Builder.ghostModel` when the user is interacting with the Habitat Builder.\n\nFor example:\n\n```cs\n        public override GameObject GetGameObject()\n        {\n            GameObject prefab = ... // code to load your prefab goes here\n\n            // Get model\n            GameObject model = prefab.FindChild(\"MY_MODEL'S_TRANSFORM\");\n\n            // help snapbuilder understand the model\n            var snapBuilder = new GameObject(\"SnapBuilder\");\n            snapBuilder.transform.SetParent(model.transform, false);\n            snapBuilder.transform.localEulerAngles = new Vector3(-90, -90, 0);\n\n            // do other stuff...\n        }\n```\n\n## Check out these other mods by Tobey!\n\n### [Fast Loading Screen](https://www.nexusmods.com/subnautica/mods/763)\n\n[![Fast Loading Screen](https://staticdelivery.nexusmods.com/mods/2706/images/thumbnails/171/171-1621479562-543452583.jpeg)](https://www.nexusmods.com/subnautica/mods/763)\n\nTurboboost your Subnautica loading times!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoebeann%2Fsnapbuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftoebeann%2Fsnapbuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftoebeann%2Fsnapbuilder/lists"}