Skip to content

Coremod to assist development of mods by checking that client-side code is only called from client-side methods

License

Notifications You must be signed in to change notification settings

rwtema/SideChecker

Repository files navigation

SideChecker

A coremod designed to check classes as they are loading and ensure that any code that calls a client-side code (i.e. code that is marked with @SideOnly(Side.CLIENT) and therefore not present in a server enviroment) is also marked with @SideOnly(Side.CLIENT).

Note: This is meant to only be used in an deobfuscated enviroment.

Installation

Please note that this is for mod developers only, and is of no use to regular players.

Download the latest compiled jar and add it to your run directory /mods/ folder.

Downloads

Version 1.1
Version 1.0

Options

Add the following VM options to configure the coreMods behaviour

-DSideChecker.filter=%packagename%
By default only classes in the 'production' directory are checked (i.e. classes than can be edited by the IDE) . If this filter is present then any class that starts with the package name will be checked.

-DSideChecker.clientSafeAnnotation=%classname%
If for some reason you wish to not use @SideOnly, then you can use the annotation given by 'clientSafeAnnotation' to mark a method as 'safe'.

-DSideChecker.crashOnError=true
When present, this will stop the execution whenever a serious error occurs.

-DSideChecker.crashOnWarning=true
The same as above, except it will also stop execution when a warning is detected.

About

Coremod to assist development of mods by checking that client-side code is only called from client-side methods

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published