I'm too lazy to write this as official documentation so I'm transcribing my experiences here for reference.
This is high level and does not cover how to setup your peer, only how to use the API itself.
This is not a tutorial.
If you are just getting started, this tutorial by DevLogLogan is worth watching.
By default, Minecraft Forge does not load dependencies from the classpath unless they are explicitly declared as mods. These steps outline how to remedy this. This guide assumes that:
To configure your Java libraries to be loaded by Forge, you should use the minecraftLibrary configuration provided by ForgeGradle.
You now must make sure to declare your dependencies using minecraftLibrary configuration.
Log4J has a feature called Java Naming and Directory Interface (shortened to JNDI in this document), which allows a Java program to reach out to an external source to gather data.
If you put a section of text containing ${jndi:query} into the log, the Log4J library will try to resolve the query.
This can be combined with the Lightweight Directory Access Protocol (LDAP) to connect to a remote server.
However, because JNDI is built for retrieving data, and JNDI is a Java program, if you put a JNDI query using LDAP into a log, it will connect to the given site, download a file, and then execute it.
This is called Remote Code Execution.
Have a repository on GitHub? Planning on making a repository on GitHub? This checklist is intended to introduce you to various features that may help you make the most of your GitHub repository with specific recommendations for C# repositories.
These are only suggestions.
They may not be appropriate for all repositories.
They are in no particular order.
Click each item to expand for more information.
| using System; | |
| using System.IO; | |
| using System.Threading.Tasks; | |
| using System.Net.Http; | |
| namespace Example | |
| { | |
| public interface IImageDownloader | |
| { | |
| Task DownloadImageAsync(string directoryPath, string fileName, Uri uri); |
| Character code (character) | Duration (ms) | Alias to | Pronounced as |
|---|---|---|---|
| 27 (�) | 656 | None | Escape |
| 33 (!) | 1333 | None | Exclamation mark |
| 35 (#) | 409 | None | Hash |
| 36 ($) | 425 | None | Dollar |
| 37 (%) | 631 | None | Percent |
| 38 (&) | 329 | None | And |
| 43 (+) | 396 | None | Plus |
| 45 (-) | 706 | None | Dash |
This primer is licensed under CC0, do whatever you want.
BUT do note that this can be updated, so leave a link here so readers can see the updated information themselves.
1.13 and 1.14 are lumped together in this doc, you're on your own if you just want to go to 1.13 and not 1.14, for some reason.
1.15 stuff: https://gist.github.com/williewillus/30d7e3f775fe93c503bddf054ef3f93e
ResourceLocation now throw on non-snake-case names instead of silently lowercasing for you, so you probably should go and change all those string constants now. More precisely, domains must only contain alphanumeric lowercase, underscore (_), dash (-), or dot (.). Paths have the same restrictions, but can also contain forward slashes (/).
git clean -fdx