Warrior
/
arbiter.js
mirror of https://github.com/WarriorRevival/arbiter.js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
theodore 2024-01-06 18:04:25 -05:00 committed by GitHub
parent 76715a89ba
commit e0ea3afb70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 100 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

114
README.md
View File

@ -1,105 +1,19 @@
# bingle-arbiter
<p align="center"><a href="https://warrior.rip" target="_blank"><img src="https://cdn.warrior.rip/img/full_logo-dark-trans.png" width="800" alt="Warrior Logo"></a></p>
<h3 align="center">A new era.</h3>
<p align="center">
<a href="https://discord.gg/V6kcPpQuE7"><img src="https://img.shields.io/discord/998257916261970041?color=fff&label=Discord%20&logo=Discord&logoColor=fff&style=flat-square" alt="Discord Server"></a>
<a href="https://github.com/WarriorRevival"><img src="https://img.shields.io/github/followers/WarriorRevival?color=fff&label=GitHub%20Followers&logo=GitHub&style=flat-square" alt="GitHub Followers"></a>
<a href="https://twitter.com/WarriorrRevival"><img src="https://img.shields.io/twitter/follow/WarriorrRevival?color=%23555555&label=Follow%20%40WarriorrRevival&logo=Twitter&logoColor=fff&style=flat-square" alt="Twitter"></a>
</p>
<h4 align="center">
This is the <b>official</b> repository for Warrior's Arbiter.JS
</h4>
<hr>
The Bingle arbiter is designed to be used with almost any revival backend.
The Bingle arbiter was created by cirroskais & unexp. It is designed to be used with almost any revival backend.
It comes preloaded with some Lua scripts made by kinery and jackd900.
It comes preloaded with some LUA scripts made by kinery and skul (d9mz / oa6z).
You **will** have to replace/modify these scripts when implementing for your own projects.
You may have to replace/modify these scripts when implementing for your own projects.
Set your desired settings in `.env.example`, then rename it to `.env`.
## Routes
### GET /render/asset/:id
<details>
<summary>200 OK</summary>
```
iVBORw0KGgoAAAANSUhEUgAAAtAAAALQCAYAAAC...
```
</details>
### GET /render/asset/3d/:id
<details>
<summary>200 OK</summary>
```json
{
"camera": {
"position": { "x": 0, "y": 0, "z": 0 },
"direction": { "x": 0, "y": 0, "z": 0 }
},
"AABB": {
"min": { "x": 0, "y": 0, "z": 0 },
"max": { "x": 0, "y": 0, "z": 0 }
},
"files": {
"scene.obj": { "content": "..." },
"scene.mtl": { "content": "..." },
"Handle1Tex.png": { "content": "..." }
}
}
```
</details>
### GET /render/texture/:id
<details>
<summary>200 OK</summary>
```
iVBORw0KGgoAAAANSUhEUgAAAtAAAALQCAYAAAC...
```
</details>
### GET /render/user/headshot/:id
<details>
<summary>200 OK</summary>
```
iVBORw0KGgoAAAANSUhEUgAAAtAAAALQCAYAAAC...
```
</details>
### GET /render/user/bodyshot/:id
<details>
<summary>200 OK</summary>
```
iVBORw0KGgoAAAANSUhEUgAAAtAAAALQCAYAAAC...
```
</details>
### GET /render/user/3d/:id
<details>
<summary>200 OK</summary>
```json
{
"camera": {
"position": { "x": 0, "y": 0, "z": 0 },
"direction": { "x": 0, "y": 0, "z": 0 }
},
"AABB": {
"min": { "x": 0, "y": 0, "z": 0 },
"max": { "x": 0, "y": 0, "z": 0 }
},
"files": {
"scene.obj": { "content": "..." },
"scene.mtl": { "content": "..." },
"Handle1Tex.png": { "content": "..." }
}
}
```
</details>