Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 41 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,53 @@
# vakfu
Wakfu map renderer
# 🌍 Vakfu

![Imgur](https://i.imgur.com/dx6mHVB.jpg)
**Vakfu** is an open-source Rust implementation of a map renderer for Wakfu, powered by the [Bevy](https://bevyengine.org/) game engine and the [byte](https://github.com/jac3km4/byte) crate for parsing game assets.

# building
![Vakfu Screenshot](https://i.imgur.com/dx6mHVB.jpg)

This project requires [cargo](https://crates.io) to build.
---

## 🛠️ Building

This project requires [Rust and Cargo](https://rustup.rs/) to build.

### Dependencies

If you are building on Ubuntu or a similar Linux distribution, you will need to install several system dependencies for the Bevy engine. You can do this with:

```bash
sudo apt-get install pkg-config libwayland-dev libxkbcommon-dev libasound2-dev libudev-dev
```

### Compiling

Once everything is in place, you can build the project by running:

Once everything is in place:
```bash
cargo build
cargo build --release
```

# using
---

## 🚀 Using

To run Vakfu, you need to point it to your local installation of Wakfu and specify a map ID.

```bash
cargo run --release -- --path /home/user/games/Ankama/Wakfu --map 999
```

Alternatively, if you've built the executable:

```bash
vakfu --path /home/jekky/games/Ankama/Wakfu --map 999
./target/release/vakfu --path /home/user/games/Ankama/Wakfu --map 999
```

Note that this project does not include **any** authored assets. In order to run it, you may get such assets by obtaining a copy of the game Wakfu, created by Ankama Games.
### ⚠️ Disclaimer

This project **does not include any authored assets**. In order to run it, you must obtain a copy of the game *Wakfu*, created and owned by [Ankama Games](https://www.ankama.com/en/games/wakfu).

---

## 📄 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
Loading