Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crystal-nest/server-sided-portals
Create custom portals and dimensions compatible with any client!
https://github.com/crystal-nest/server-sided-portals
minecraft minecraft-api minecraft-fabric-mod minecraft-forge-mod minecraft-mod minecraft-neoforge-mod mod-api
Last synced: about 1 month ago
JSON representation
Create custom portals and dimensions compatible with any client!
- Host: GitHub
- URL: https://github.com/crystal-nest/server-sided-portals
- Owner: Crystal-Nest
- License: gpl-3.0
- Created: 2024-08-07T15:57:30.000Z (3 months ago)
- Default Branch: 1.21
- Last Pushed: 2024-10-07T18:32:07.000Z (about 1 month ago)
- Last Synced: 2024-10-09T12:04:54.775Z (about 1 month ago)
- Topics: minecraft, minecraft-api, minecraft-fabric-mod, minecraft-forge-mod, minecraft-mod, minecraft-neoforge-mod, mod-api
- Language: Java
- Homepage: https://modrinth.com/mod/server-sided-portals
- Size: 1.59 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
---
[](https://modrinth.com/mod/server-sided-portals/versions?g=1.21.1)[](https://modrinth.com/mod/server-sided-portals/versions?g=1.21)[](https://modrinth.com/mod/server-sided-portals/versions?g=1.20.4)[](https://modrinth.com/mod/server-sided-portals/versions?g=1.20.2)[](https://modrinth.com/mod/server-sided-portals/versions?g=1.20.1)[](https://modrinth.com/mod/server-sided-portals/versions?g=1.19.4)[](https://modrinth.com/mod/server-sided-portals/versions?g=1.19.2)
[](https://modrinth.com/mod/server-sided-portals/versions?l=neoforge)[](https://modrinth.com/mod/server-sided-portals/versions?l=forge)[](https://modrinth.com/mod/server-sided-portals/versions?l=fabric)
[](https://github.com/crystal-nest/server-sided-portals/issues)
---
## **Description**
This is a mod API that provides easily customizable and server-sided portals to any custom dimension.
This mod is required server side only, and is thus compatible with any client, Vanilla included.
This mod can be used as a dependency for another mod/datapack, or bundled in a modpack with a custom datapack or with mods that require it.
Check out the usage details below or on the [Wiki](https://github.com/Crystal-Nest/server-sided-portals/wiki)!
## **Features**
- Allows the creation of portals with a custom frame that are linked for a specific dimension.
- Choose the frame blocks simply with a block tag! Multiple blocks are allowed!
- Required only server side!
- Fully compatible with both modded and Vanilla clients.
- Easy to use with either a mod or a datapack.
## **Usage**
### Datapack
It's very easy to make use of this mod API with a custom datapack:
1. Create a datapack following [this tutorial](https://minecraft.wiki/w/Tutorials/Creating_a_data_pack).
2. Create a custom dimension type with [this generator](https://misode.github.io/dimension-type/).
3. Create a custom dimension with [this generator](https://misode.github.io/dimension/).
4. Create a custom block tag for the portal frame. You can add multiple blocks and other block tags too!
5. Make sure all the JSON files you created in the previous steps are called the exact same.
That's it! When the datapack is loaded along with this mod, all dimensions will be loaded, and it'll be possible to create portals with the specified frame blocks!
You can also add multiple dimensions, each with its custom portal definition: just make sure that, for each one, the dimension files and the block tag file are called the same.
### Mod
Making a mod that leverages this API is simple.
Follow the instructions in the datapack section above, but put the files under `resources/data/mod_id/`.
Making a mod rather than a datapack might be useful for adding extra functionality regarding your dimension.
You can check out a working example [here](https://github.com/Crystal-Nest/nightworld).
There are also a few useful utility methods available, for which you can check out the Javadoc for more details.
## **Compatibilities**
| Mod | Loader | Compatibility |
|:---------------------------------------------------------------|:------:|:------------------------------------------------------------------------------------------------------------------------------:|
| [Crying Portals](https://modrinth.com/mod/crying-portals) | All | Incompatible |
| [Immersive Portals](https://modrinth.com/mod/immersiveportals) | All | Incompatible |
| [Very Many Players](https://modrinth.com/mod/vmp-fabric) | Fabric | Compatible with `use_async_portals=false` |
| [Canary](https://modrinth.com/mod/canary) | Forge | Compatible with [fast portals](https://github.com/AbdElAziz333/Canary/wiki/Configuration-File#mixinaipoifast_portals) disabled |
## **Dependencies**
| Mod | Loader | Requirement |
|:------------------------------------------|:------:|:-----------:|
| [Cobweb](https://modrinth.com/mod/cobweb) | All | Required |
## **License and right of use**
Feel free to use this mod for any modpack or video, just be sure to give credit and possibly link [here](https://github.com/crystal-nest/server-sided-portals#readme).
This project is published under the [GNU General Public License v3.0](https://github.com/crystal-nest/server-sided-portals/blob/master/LICENSE).
## **Support us**
[](https://bisecthosting.com/crystalspider)