Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kneelawk/graphlib
Library for helping mods that use graph networks of blocks
https://github.com/kneelawk/graphlib
Last synced: 2 months ago
JSON representation
Library for helping mods that use graph networks of blocks
- Host: GitHub
- URL: https://github.com/kneelawk/graphlib
- Owner: Kneelawk
- License: mit
- Created: 2022-05-02T00:10:45.000Z (over 2 years ago)
- Default Branch: 2.x-1.21.x
- Last Pushed: 2024-08-11T23:01:14.000Z (5 months ago)
- Last Synced: 2024-10-15T06:34:02.167Z (3 months ago)
- Language: Java
- Homepage:
- Size: 2.32 MB
- Stars: 21
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelogs/changelog-v0.1.0+1.18.2.md
- License: LICENSE
Awesome Lists containing this project
README
# GraphLib
[![Github Release Status]][Github Release] [![Maven Status]][Maven] [![Javadoc Badge]][Javadoc] [![Discord Badge]][Discord] [![Ko-fi Badge]][Ko-fi]
[Github Release Status]: https://img.shields.io/github/v/release/Kneelawk/GraphLib?include_prereleases&sort=semver&style=flat-square&logo=github
[Github Release]: https://github.com/Kneelawk/GraphLib/releases/latest
[Maven Status]: https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fkneelawk.com%2Fmaven%2Fcom%2Fkneelawk%2Fgraphlib%2Fcore-xplat-intermediary%2Fmaven-metadata.xml&style=flat-square&logo=apachemaven&logoColor=blue
[Maven]: https://kneelawk.com/maven#com/kneelawk/graphlib
[Javadoc Badge]: https://img.shields.io/badge/-javadoc-green?style=flat-square
[Javadoc]: https://kneelawk.com/docs#graphlib
[Discord Badge]: https://img.shields.io/discord/988299232731607110?style=flat-square&logo=discord
[Discord]: https://discord.gg/6vgpHcKmxg
[Ko-fi Badge]: https://img.shields.io/badge/ko--fi-donate-blue?style=flat-square&logo=kofi
[Ko-fi]: https://ko-fi.com/kneelawk
Library for helping mods that use graph networks, like Wired Redstone.
## GraphLib and HCTM-Base
This library is based on [HCTM-Base by 2xsaiko][HCTM-Base] and is essentially a rewrite of his block-graph-network code
in Java with some optimizations. Credit goes to 2xsaiko for designing this system in the first place.
[HCTM-Base]: https://github.com/2xsaiko/hctm-base
## Commands
All commands can be accessed via the `/graphlib` command.
### `/graphlib debugrender start` and `/graphlib debugrender stop`
These commands are used for starting and stopping the block graph debug renderer. The debug renderer can help you debug
your code that uses GraphLib or figure out why your wires aren't connecting after a server crash.
### `/graphlib updateblocks `
This command updates all block-nodes in a given area. If block-nodes were not saved due to a server crash then it may
cause some machines or wires to act strange, not transmitting signals correctly. This command will re-connect those
machines.
### `/graphlib removeemptygraphs`
Sometimes a server crash can cause a block-graph to get saved without any block-nodes in it. These empty graphs can
clutter up your save file. This command removes these empty graphs.
### `/graphlib rebuildchunks `
Sometimes a server crash can cause only graphs or only chunk-indexes to be saved but not the other, meaning that the
index used to look up which graphs are in which positions could be out of date. This command rebuilds that index for the
given chunks.
**Note: the command arguments `` and `` are block-positions, not chunk positions. Running this command for one
block in a 16x16x16 chunk section should fix the entire chunk section.**
## Depending on GraphLib
GraphLib can be added to a gradle project's dependencies like such:
```groovy
repositories {
maven {
url 'https://kneelawk.com/maven/'
name 'Kneelawk Maven'
}
maven {
// For LibNetworkStack, if using 'syncing' module
url 'https://maven.alexiil.uk/'
name 'AlexIIL Maven'
}
}
dependencies {
modImplementation("com.kneelawk.graphlib:core:$graphlibVersion")
include("com.kneelawk.graphlib:core:$graphlibVersion")
}
```
where `$graphlibVersion` is replaced by GraphLib's latest release version.