Giter Club home page Giter Club logo

backrooms-mod's Introduction

Backrooms Exploration

This is a Fabric 1.18.2 mod adding the Backrooms to Minecraft.

[README still incomplete]

Features

This mod, by itself will add Levels 0-TBD of the Backrooms to Minecraft. These will likely primarily be based on the Wikidot (Tech Support) versions of these Levels, though this does not exclude the possibility of elements from elsewhere being included.

Levels

In the latest snapshot:

  • Level 0
  • Level 1

Entities

There are Entities lurking around, so better watch out! They are also primarily based on the Wikidot. In the latest snapshot:

  • Hound

Items

  • Almond Water
  • Fire Salt

Miscellaneous

  • Wretched Cycle

[TODO]

Addon system

This mod will have a system for addon mods to integrate with this mod and add new Levels, and possibly even alter or replace existing Levels. Anyone will be free to develop an addon for this mod, as long as they comply with the LGPL-v3.0 license terms of this mod.

Install & Play

Since the mod is not ready for release yet, there is no Curseforge or Modrinth release. However, if you want to play the mod right now (with bugs and instability), you can download Actions Artifacts or the latest snapshot.

Get the .jar

Artifacts

Artifacts are built by Github Actions, an automatic tool that tries to build the mod whenever there is a new commit (update in source). Often the builds are very unstable or unplayable and sometimes the build fails. However, it contains the newest features we are working on. To download an Artifact, you must be logged in with your Github account. Go to the Actions tab, click on a run and scroll down to the the "Artifacts" section. Download "Mod.zip" and extract it. There should be the *.jar file.

Snapshots

Snapshots are still work-in-progress builds, but they are considered as more stable than Artifacts. You can download the .jar in the release tab:

Install the mod

This is a Fabric 1.18.2 mod, so you need a Fabric 1.18.2 profile with a mods folder. Place the .jar file there.

The Backrooms mod depends on some other mods and libraries. You must install them with the right version (compatible with 1.18.2):

  • ClothConfig (6.5.116)
  • Mod Menu (3.2.5)
  • Satin API (1.7.2) (there is no 1.18.2 version, so we use 1.18.1 version)
  • Geckolib (3.0.80)

Other versions may work, but it is not guaranteed.

Settings

You can change some settings. In Mod Menu, click on the Backrooms and open the configuration screen.

Building and Running

If you are a developer, you can build the mod on your own and run a debug build. Make sure you have JDK 17 installed on your machine, since we use 1.18.2 and Gradle 7.4. Clone this Repository and open it in your preferred IDE. Follow the instructions on the Fabric Wiki. You can skip "Mod Setup".

License

This mod is licensed under the LGPL v3.0.

backrooms-mod's People

Contributors

megduck avatar jsmeansjauhesammutin avatar trimsku avatar encryptionstudio avatar planet-man38 avatar shin1ma avatar valiec avatar hugomskn avatar chocotoneg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.