Skip to content

Commit 3cd93d7

Browse files
Add license and readme
1 parent 0e334a8 commit 3cd93d7

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020-2025 OpenFusion Contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# OpenFusionMap-rs
2+
3+
OpenFusion player map in your browser.
4+
5+
OpenFusionMap-rs is a rewrite of [OpenFusionMap](https://github.com/OpenFusionProject/OpenFusionMap) in Rust using [axum](https://github.com/tokio-rs/axum) and [ffmonitor](https://github.com/OpenFusionProject/ffmonitor)
6+
7+
## Building
8+
```
9+
cargo build --release
10+
```
11+
12+
## Usage
13+
```
14+
Usage: openfusionmap [OPTIONS]
15+
16+
Options:
17+
-b, --bind-addr <BIND_ADDR> The address to bind the HTTP server to [default: 127.0.0.1:8080]
18+
-m, --monitor-addr <MONITOR_ADDR> The address of the OpenFusion monitor to connect to [default: 127.0.0.1:8003]
19+
-h, --help Print help
20+
```
21+
Then connect in your browser.

0 commit comments

Comments
 (0)