Modrinth · Forge, NeoForge

Integrated REST on your Minecraft server

Integrated REST runs on Minecraft servers with Forge or NeoForge. Order your server, set the loader in the panel and install the mod with one click in the mod browser.

Expose Integrated Dynamics networks as a REST API

Downloads
14.0K
Author
rubensworks
Loader
Forge, NeoForge
Minecraft
1.18.2 – 26.3
Updated
–

Setup

Install Integrated REST on your server

The server and players need the same loader and Minecraft version. Back up the world before adding or updating mods.

  1. 01

    Configure

    4 GB of RAM is preselected. You choose the term and add-ons and pay by credit card or PayPal.

  2. 02

    Set the loader

    In the panel, set the server software to Forge or NeoForge and choose the matching Minecraft version, for example 26.3.

  3. 03

    Install the mod

    Search the mod browser for “Integrated REST” and install the release for your loader. Alternatively, upload the .jar to the mods folder via SFTP. Required dependencies are listed on the project page.

  4. 04

    Connect

    Every player installs the same Integrated REST release locally and connects using the server address from the panel.

On the server
Required
On the client
Required
Loader
Forge, NeoForge
Minecraft
26.3, 26.2, 26.1.2 +14 more
License
MIT License

The panel

Install mods, find errors.

Real screenshots from the Mado panel. Both come with every Minecraft server.

Mod browser

Modrinth and CurseForge, right in the panel.

The browser filters by your Minecraft version. Install mods with one click, without uploading .jar files.

Browser in the Mado panel with search, a CurseForge or Modrinth source switch and install buttons.

AI crash analysis

When a mod crashes, the analyzer reads the log.

Mods often fail on a wrong loader version, Java version or missing dependency. The analyzer names a likely cause and suggests a fix.

Optimization page in the Mado panel with the AI Log Analyzer enabled and a “Server Crashed” notice with an “Analyze Now” button.

Releases

Published releases

Pick the file that matches your server’s loader and Minecraft version. The server and players need the same release.

Integrated REST · Modrinth
Original description by the project author

 

This requires the Cyclops Core library and Integrated Dynamics! Come talk to us in #integratedmods on the Cyclops Discord server!

 

This mod allows you to read from and write to your Integrated Dynamics networks via a REST API.
This makes it possible to read the status of your networks and worlds via Web-protocols, and interact with them by POST-ing values to HTTP Proxy blocks in your world.

 

Some examples on what is possible with this mod (and some external coding):

  • Control the lights of your home based on the day time in your Minecraft world.
  • Play a sound in Minecraft when you receive an email.
  • Show the positions of all online players in the overworld on your website.
  • Open a door from your mob farm when you gain a new Twitch or Mixer subscriber.

 

WARNING: If you have never heard about 'API' or 'REST' before, then this probably is nothing for you. This mod is mainly aimed at advanced users wanting to do very advanced automation using external system that can communicate over HTTP.

 

This mod exposes your networks as JSON on a configurable port. Here is a snippet of a single network element output:

 

{
  "@context": "https://raw.githubusercontent.com/CyclopsMC/IntegratedREST/master-1.12/src/main/resources/context.jsonld",
  "@id": "http://localhost:3000/",
  "networkElements": [
    {
      "@id": "http://localhost:3000/networkElement/integrateddynamics/part/4",
      "position": {
        "world": 0,
        "x": -26,
        "y": 57,
        "z": -249,
        "side": "ir:east"
      },
      "block": "http://localhost:3000/registry/block/integrateddynamics/cable",
      "@type": [
        "NetworkElement",
        "http://localhost:3000/registry/part/display_panel"
      ],
      "channel": 0,
      "priority": 0,
      "updateInterval": 1,
      "network": "http://localhost:3000/network/1619976862",
      "valueType": "http://localhost:3000/registry/value/valuetype/valuetypes/integrateddynamics/string/name",
      "value": "I was updated\\nvia HTTP!",
      "target": {
        "world": 0,
        "x": -25,
        "y": 57,
        "z": -249,
        "side": "ir:west"
      },
      "loaded": true
    },
  ...
  ]
}

In fact, this JSON is valid JSON-LD (Linked Data JSON), which makes it possible to use this output in RDF tools. 

 

Next to the state of your network and its elements, this mod also exposes the state of most Forge registries.
All available information (accessible via the API index page):

  • Networks
  • Network elements
  • Part types
  • Aspect types
  • Value types
  • Items
  • Blocks
  • Fluids
  • Mods

This mod adds a single craftable block to the game, the HTTP Proxy.

 

Like all network elements, this block is accessible via HTTP. For example, an HTTP Proxy with ID 7 will be accessible via http://localhost:3000/networkElement/integrateddynamics/http/7.

This block has an internal value state that can be updated via HTTP POST requests (more information on the wiki).

 

Note: If you are using this mod on a server, you'll probably want to disable starting up the HTTP server client-side, by disabling it via the config file of the players.

 

This mod collects anonymized startup data, this can be disabled in the config file and adheres to Minecraft's snooper settings.

 


If you like this mod, consider supporting me on Patreon!

FAQ

Integrated REST questions

Question not listed? Ask our team.

Integrated REST server crashes on startup – what to do?

Common causes: the loader or Minecraft version does not match the mod file, a dependency is missing, or RAM is too low. Check the log (latest.log) for “OutOfMemoryError”, “Mixin” or missing mods. At Mado, the AI crash analysis reads the log and suggests a cause. You can change the loader and version in the panel.

Which loader does Integrated REST run on?

According to Modrinth, Integrated REST supports Forge, NeoForge for Minecraft 26.3, 26.2, 26.1.2.

How much RAM does a server with Integrated REST need?

As guidance, 3–4 GB for a server with this mod. This is an estimate, not a measured minimum. More mods, many players and long view distances need more. The spark profiler shows whether a mod is costing tick time.

Ready for your server with Integrated REST?

4 GB of RAM from €8.00 per month. 35% off your first month with MADO35.

Order server