SwiftApi

Czym jest SwiftApi?

SwiftApi to interfejs API oparty na Apache Thrift dla serwerów Minecraft CraftBukkit. Ta API umożliwia proste wywoływania metod Bukkit przez Internet przy użyciu wybranego przez Ciebie języka programowania. Ta wtyczka działa jako komponent serwera, umożliwiając napisanie programów klienckich/stron internetowych/aplikacji, które mogą komunikować się z Twoim serwerem CraftBukkit w niemal każdym języku programowania!

SwiftApi 2.0

SwiftApi-2.0-alpha jest teraz dostępny do pobierania razem z pobieranie razem z SwiftApiVault-1.0-alpha. Sprawdź wiki, aby uzyskać więcej informacji.

Co możesz z tym zrobić?

W skrócie, SwiftApi pozwala Ci pisać świetny kod i aplikacje, które mogą łączyć się z i kontrolować Twój serwer Minecraft.

Przykładem takiej aplikacji jest MineCenter. Sprawdź ją pod adresem http://minecenter.org

Opcje konfiguracji

Edytuj plik plugins/SwiftApi/config.yml według własnych potrzeb.

Najważniejsze opcje to:

# Authentication Information (CHANGE THESE)
username: admin
password: password
salt: saltines

Pozostawienie tych ustawień domyślnych ułatwi użycie tego API na Twoim serwerze.

Tworzenie aplikacji klienckiej

Gdy pobierzesz kompilator Apache Thrift, możesz stworzyć aplikację kliencką w kilku linijkach kodu.

Sprawdź tutaj przykładowy projekt PHP: https://github.com/phybros/swiftapi-example-php

Wypróbuj tutaj samouczek C#.NET/VB.NET: http://dev.bukkit.org/server-mods/swiftapi/pages/examples/c-net-vb-net/

Wygeneruj bibliotekę kliencką

Możesz wygenerować bibliotekę kliencką (przykład w C#) wpisując

thrift -r --gen csharp SwiftApi.thrift

Opcja -r mówi kompilatorowi, aby generował kod dla wszystkich plików (w tym te, które są odwoływane w SwiftApi.thrift za pomocą dyrektywy include). Opcja gen csharp mówi kompilatorowi, aby generować kod C#. To polecenie pozostawi Ci katalog gen-csharp z całym kodem, którego potrzebujesz, aby połączyć się z serwerem uruchamiającym wtyczkę SwiftApi.

Dołącz kod do swojej aplikacji

Jeśli używasz C#, możesz po prostu przeciągnąć wszystkie pliki źródłowe bezpośrednio do swojej aplikacji klienckiej, aby z nich korzystać, lub alternatywnie możesz utworzyć nowy projekt z wygenerowanymi plikami, aby utrzymać kod i kod wygenerowany w oddzieleniu.

Przykłady

Odwiedź stronę Examples page dla przykładów, jak używać kodu.

Oto przykład w C#:

//open a connection to a server running SwiftApi
TSocket socket = new TSocket("your.bukkitserver.org", 21111);
socket.Open();

//create a new SwiftApi client object
TBinaryProtocol protocol = new TBinaryProtocol(new TFramedTransport(socket));
SwiftApi.Client client = new SwiftApi.Client(protocol);

//get the server version and output it
Console.WriteLine("Server Version: " + client.getServerVersion(authString));

//close the connection
socket.Close();

Ponieważ kod oparty jest na Apache Thrift, masz dostęp do wielu złożonych typów w API CraftBukkit, takich jak obiekt Player.

Ten przykład jest w C#, ale kompilator Thrift potrafi tworzyć biblioteki dla prawie dowolnego języka programowania.

Odwiedź stronę Examples page dla przykładów w innych językach

Dostępne języki programowania

Od wersji Apache Thrift 0.9.0 dostępne są następujące języki:

• ActionScript 3 (AS3)
• C (używający GLib)
• C
• C#
• Cocoa (Objective-C na Mac OS i iOS)
• Delphi
• Erlang
• Go
• Haskell
• Java
• JavaScript
• OCaml
• Perl
• PHP
• Python (w tym obsługa asynchroniczna Twisted)
• Ruby
• Smalltalk

Kod

Myślisz, że możesz ulepszyć SwiftApi? Zrób forka repozytorium na Bitbucket i wyślij pull request!

Repo URL: https://bitbucket.org/phybros/swiftapi

Uwagi

Ta wtyczka wysyła anonimowe statystyki użytkowania na http://mcstats.org/

Aby zrezygnować z udziału, ustaw opt-out na true w plugins/PluginMetrics/config.yml