https://github.com/aikar/minecraft-timings

A Library to implement against Minecraft Timings - [V1 (Spigot), V2 (Paper)], and gracefully do nothing if no timings is supported.
https://github.com/aikar/minecraft-timings

Last synced: about 2 months ago
JSON representation

A Library to implement against Minecraft Timings - [V1 (Spigot), V2 (Paper)], and gracefully do nothing if no timings is supported.

• Host: GitHub
• URL: https://github.com/aikar/minecraft-timings
• Owner: aikar
• License: mit
• Created: 2017-05-03T01:33:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-17T06:14:00.000Z (almost 7 years ago)
• Last Synced: 2024-10-11T03:21:34.932Z (2 months ago)
• Language: Java
• Homepage:
• Size: 12.7 KB
• Stars: 23
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Minecraft Timings Library

This library lets Bukkit Plugin developers SAFELY add Timings support to their plugin.

There are 2 versions of Timings

  - V1: Used by Spigot. Developed by Aikar and labeled "Spigot Timings"

  - V2: Relabeled "Minecraft Timings", and supported by many various server software products.

  

Timings v2 added a proper API, however implementing it meant that your plugin would REQUIRE Paper,

or else things would blow up around Timings.

This library will safely analyze the current environment, and load an appropriate timings integration

according to what is available.

If using on CraftBukkit, or older versions of Spigot before Timings got added, then a "no op" Timings

handler will be used that does nothing.

On Spigot, Timings v1 will be used.

On everything else (Paper 1.8.8+), v2 will be used.

## Usage

Simply add my maven repo to your plugin and add v1.0.2 as a dependency, and shade/shadow it in.

### Maven

```xml

    

    

        

            aikar

            http://repo.aikar.co/nexus/content/groups/aikar/

        

    

    

    

    

        

            co.aikar

            minecraft-timings

            1.0.4

        

    

    

    

    

        

            

                org.apache.maven.plugins

                maven-shade-plugin

                2.4.1

                

                    ${project.build.directory}/dependency-reduced-pom.xml

                    

                        

                            co.aikar.timings.lib

                            [YOUR PLUGIN PACKAGE].timingslib

                        

                    

                

                

                    

                        package

                        

                            shade

                        

                    

                

            

        

    

```

### Gradle

```gradle

buildscript {

    repositories {

        jcenter()

    }

    dependencies {

        classpath "com.github.jengelman.gradle.plugins:shadow:1.2.4"

    }

}

apply plugin: "com.github.johnrengelman.shadow"

apply plugin: 'java'

sourceCompatibility = '1.8'

targetCompatibility = '1.8'

repositories {

    maven { url = "http://repo.aikar.co/nexus/content/groups/aikar/" }

    maven { url = "https://hub.spigotmc.org/nexus/content/groups/public/" }

}

dependencies {

    compile "co.aikar:minecraft-timings:1.0.4"

}

shadowJar {

   relocate 'co.aikar.timings.lib', '[YOUR PLUGIN PACKAGE].timingslib'

}

```

### Code

In your plugin

```java

private static TimingManager timingManager;

public void onEnable() {

    timingManager = TimingManager.of(this);

}

public static MCTiming timing(String name) {

    return timingManager.of(name);

}

```

Then use `YourPlugin.timing("Foo")` or don't use static and just use a dependency injection approach.