1. Place NoLagg.jar into the plugins folder
2.1. Install BKCommonLib.jar into the plugins folder. NoLagg uses it to communicate with Minecraft. See: http://dev.bukkit.org/server-mods/bkcommonlib/
2.2. If you have an old version of 'BKCommonLib' on your server, replace it with the latest version if a new one is available
3. optional: You can add the example configuration folder; the plugin will create one itself if it is not present
4. Configure what components of NoLagg you want to enable in 'config.yml'

You can find possible permission nodes for this plugin in the 'PermissionDefaults.yml' file.
This file is both included in this download (see the plugin folder) and is generated by the plugin.

For spawn limiting I recommend finding an alternative, since NoLagg's version can cause a heavy tick rate drop on server
hosting 10K+ mobs. This is especially the case on large-player-count servers. If you host around 100 players and have over 10K chunks loaded on average, 
do not use NoLagg to do this. You really need a plugin that can do these things more efficiently. (reason being that NoLagg has a lot of hierarchical naming rules)

- Older versions are (almost always) compatible with newer BKCommonLib libraries; it has backwards compatibility.
- Do not put the BKCommonLib in the 'lib' folder; it will not function that way.
- BKCommonLib will show up as a separate running plugin, but won't do anything but monitor certain dependencies

The source of BKCommonLib can be read from:
https://github.com/bergerkiller/BKCommonLib

=======================================
================General================
=======================================

In previous versions multiple jar files were used, this has been changed. Instead all components are in one jar file.
To set what components (and thus features) to use, change the enable: true/false for that component in the configuration (config.yml)
All permissions can also be set in one file (PermissionDefaults.yml)

You can remove all previous folders (NoLaggMonitor, NoLaggItemStack, NoLaggChunks, etc.) as they are no longer used.

==================================================
================Which should I install?================
==================================================

==High-performance servers==
If you run a server with a lot of entities and chunks loaded and moving, do not enable the spawn limiter unless you want to test things out.
Since it has to operate on every single entity, it tends to run very sluggish. It is only useful if your server entity count is below 10000 entities.

==Low on RAM==
There were some RAM-lowering features in the past, but they proved to cause more harm than good.
Nevertheless, all features are optimized to re-use objects and will try to affect RAM memory as least as possible.
If you really need to lower the RAM usage, it is best to:
- Use a world management plugin to disable the 'keep spawn in memory' (ultimately frees some chunks)
- Lower the server view distance in the server.properties file
- Enable the 'chunks' component to reduce chunks loading for no reason when players fly through the air

==General reasons==
- If you want to prevent client and possible server tick rate lag, you can use the item stacker and item buffer components to clear items from the world.
- If you want to prevent certain mobs from spawning, use the spawn limiter
- If you want to examine the server tick rate performance now and then, use the examine component
- If you want to monitor server performance or notify players when the server lags, use the monitor component
- If you are tired of the (client-lagging) black shadows around caves and cliffs, use the lighting component
- If you want to secure your worlds and don't want to lose data when the server crashes, use and configure the saving component
- If you want to allow TNT on your server but are afraid of lag, use the TNT component
- If you want to improve chunk sending to your clients, use the chunks component
- If you want to clear entities from the server or garbage-collect server memory, use the common component

If you don't use it, don't enable it.

==================================================
================Examine component================
==================================================

You can use /nolagg examine to examinate the server for a set amount of ticks. (default 500)

The results will be exported in the plugins folder
To view the results, open the file using 'NoLagg.jar'
(Double-click the NoLagg.jar file, or if not possible, open it using java.exe)
This program can render the graphs contained in the exam file values.

NoLagg.jar is both a plugin and a java application.
You can double-click it to run the application (standard launch)
You can put it in plugins to use the /lag examine command and generate a report

If you have tick rate issues and need to understand why, you can examine the server.
If you don't understand the graphs yourself, feel free to upload the file so I can view it locally.

The examine viewer has been significantly improved:
- it is faster
- now sorts the results so it is easier to view minor results.
- now shows the process time next to the element name
- now allows the window to be resized and made full-screen
- vertical scrollbar annoyances fixed
- both a plugin-event and event-plugin view

==================================================

~Bergerkiller