Skip to content

Commit 3541a88

Browse files
committed
chore: document requirements for AvatarController
1 parent a53f9ea commit 3541a88

File tree

4 files changed

+22
-0
lines changed

4 files changed

+22
-0
lines changed
50.7 KB
Loading
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Intersect.Server /avatar/ API (AvatarController)
2+
3+
Avatars are loaded from the save `entities` and `faces` directories that the Client and Editor usually use. Since the server is the one sending them, in this rare case the server actually needs the resources.
4+
5+
For completeness and coverage of potential future features or enhancements, please copy the _entire_ **Editor** `resources` directory (don't copy resource packs meant for the client!) to the `assets/editor` directory (you may need to create this!) in the server's working directory.
6+
7+
At a minimum, the `entities` and `faces` directories are required. In the future, the `paperdolls` folder will also be required.
8+
9+
As shown in the below screenshot, `assets` should be a _sibling_ directory to the normal `logs` and `resources` directories of the server, and the editor resources are located in `assets/editor/resources`.
10+
11+
![File Structure Editor Resources](AvatarController.FileStructureEditorResources.png)
86.6 KB
Loading

Documentation/Features.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Features
2+
3+
## Server
4+
5+
### Homepage
6+
7+
This is a sample preview of the server built-in homepage, which includes a very basic leaderboard as well as user login/logout.
8+
9+
**By default the server does not have the assets to serve the in-game graphics as shown in the screenshot below, it requires a manual step. If you would like to see the in-game graphics please follow the instructions for the [AvatarController](./AvatarController/AvatarController.md).**
10+
11+
![Homepage Leaderboard](Features.HomepageLeaderboard.png)

0 commit comments

Comments
 (0)