Skip to content

Commit 2442031

Browse files
authored
Update README.md
1 parent 721088a commit 2442031

1 file changed

Lines changed: 1 addition & 91 deletions

File tree

README.md

Lines changed: 1 addition & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1 @@
1-
## Summary
2-
3-
Stealth Client is an alternative Ultima Online client written in Delphi and distributed on their [website](https://stealth.od.ua/ "website"). Stealth exposes a socket based external api which is subject of this project.
4-
5-
ScriptSDK.Api is an implementation of external api. It includes all kind of functions and events to communicate with Stealth.
6-
7-
### Requirements
8-
9-
- [Lombok](https://projectlombok.org/ "Lombok")
10-
11-
- [OpenJDK 17](https://adoptium.net/ "OpenJDK 17")
12-
13-
- [Access to scriptsdk.core](https://github.com/stealth-scriptsdk/java-core "Access to scriptsdk.core")
14-
15-
## Features
16-
17-
- Implementation of ApiClient including 422 methods & events
18-
- Implementation of generic api test suite for 418 methods & events
19-
20-
### Excluded methods
21-
22-
- CLEAR_FIGURES
23-
- REMOVE_FIGURE
24-
- ADD_FIGURE
25-
- MESSENGER_GET_CONNECTED
26-
- MESSENGER_SET_CONNECTED
27-
- MESSENGER_GET_TOKEN
28-
- MESSENGER_SET_TOKEN
29-
- MESSENGER_GET_NAM
30-
- MESSENGER_SEND_MESSAGE
31-
- GET_MULTI_ALL_PARTS
32-
- GET_MULTI_PARTS_AT_POSITION
33-
- HTTP_GET
34-
- HTTP_POST
35-
- HTTP_BODY
36-
- HTTP_HEADER
37-
38-
### Excluded test methods
39-
- stopScript
40-
- stopAllScripts
41-
- setTimer1Event
42-
- setTimer2Event
43-
44-
## Installation
45-
46-
### 🛠 Use source code
47-
48-
Developers can fork this repository and use it as it is for their own forks or implementations. Even thought its possible to directly use the sourcecode as base, its recommned to implement this project as maven package.
49-
50-
### 📦 Use as maven package
51-
52-
In order to use Github maven repositories, developers must be registered at github and being able to create a [personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token "personal access token").
53-
54-
As next step the personal access token must be usable through local maven repository by adding a **Settings.xml** to local .m2 folder. This is regulary located at **C:\Users\USER\.m2\**
55-
56-
```xml
57-
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
58-
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
59-
<servers>
60-
<server>
61-
<id>github</id>
62-
<username>USERNAME</username>
63-
<password>AUTH_TOKEN</password>
64-
</server>
65-
</servers>
66-
</settings>
67-
```
68-
69-
The last step is adding references to package repository to pom.xml file.
70-
71-
```xml
72-
<repositories>
73-
<repository>
74-
<id>github</id>
75-
<name>GitHub ScriptSDK Java Core</name>
76-
<url>https://maven.pkg.github.com/stealth-scriptsdk/java-api</url>
77-
<releases><enabled>true</enabled></releases>
78-
<snapshots><enabled>false</enabled></snapshots>
79-
</repository>
80-
</repositories>
81-
```
82-
83-
84-
85-
```xml
86-
<dependency>
87-
<groupId>de.scriptsdk</groupId>
88-
<artifactId>api</artifactId>
89-
<version>1.0.0</version>
90-
</dependency>
91-
```
1+
The Documentation of this project has been moved to a collective [Documentation](https://github.com/stealth-scriptsdk/java-docs/wiki/Api).

0 commit comments

Comments
 (0)