snow/readme.md

49 lines
3.2 KiB
Markdown
Raw Normal View History

2023-11-02 21:09:45 +00:00
![1](https://github.com/ectrc/snow/assets/13946988/fc007f07-3878-46e7-b990-668fc3d758d0)
2023-10-31 22:40:14 +00:00
# Snow
2024-02-04 20:24:15 +00:00
> Performance first, feature-rich universal Fortnite private server backend written in Go.
2023-10-31 22:40:14 +00:00
2024-02-04 02:33:03 +00:00
## Overview
2023-10-31 22:40:14 +00:00
2024-01-04 19:40:50 +00:00
- **Single File** It will embed all of the external files inside of one executable! This allows the backend to be ran anywhere with no setup _(after initial config)_!
2024-01-21 00:50:54 +00:00
- **Blazingly Fast** Written in Go and built upon Fast HTTP, it is extremely fast and can handle any profile action in milliseconds with its caching system.
2024-02-04 02:33:03 +00:00
- **Automatic Profile Changes** Automatically keeps track of profile changes exactly so any external changes are displayed in-game on the next action.
2023-12-31 14:59:20 +00:00
- **Universal Database** It is possible to add new database types to satisfy your needs. Currently, it only supports `postgresql`.
2023-10-31 22:40:14 +00:00
2024-02-04 20:24:15 +00:00
## What's up next?
2023-11-05 02:20:40 +00:00
2024-02-04 02:33:03 +00:00
- Seeded randomization for the **Item Shop** instead of a random number generator. This will ensure that even if the backend is restarted, the same random items will be in the shop during that day.
- Purchasing the **Battle Pass**. This will require the Battle Pass Storefront ID for every build. I am yet to think of a solution for this.
2024-02-04 02:33:03 +00:00
- Interaction with a Game Server to handle **Event Tracking** for player statistics and challenges. This will be a very large task as a new specialised game server will need to be created.
- After the game server addition, a **Matchmaking System** will be added to match players together for a game. It will use a bin packing algorithm to ensure that games are filled as much as possible.
2024-02-10 00:34:12 +00:00
And once battle royale is completed ...
2024-02-10 00:34:12 +00:00
- **Save The World**
2024-02-16 01:14:14 +00:00
## Feature List
2024-02-17 15:42:04 +00:00
- **XMPP** For interacting with friends, parties and gifting.
- **Friends** On every build, this will allow for adding, removing and blocking friends.
2024-02-16 01:14:14 +00:00
- **Party System V2** This replaces the legacy xmpp driven party system.
- **Gifting** Of any item shop entry to any friend.
- **Locker Loadouts** On seasons 12 onwards, this allows for the saving and loading of multiple locker presets.
- **Item Refunding** Of previous shop purchases, will use a refund ticket if refunded in time.
- **Universal Item Shop** Works on all builds and will be updated every 24 hours.
- **Client Settings Storage** Uses amazon buckets to store client settings.
- **Support A Creator 5%** Use any display name and each purchase will give them 5% of the vbucks spent.
- **Discord Bot** Very useful to control players, their inventory and their settings
2024-02-03 02:46:49 +00:00
## Supported MCP Actions
2023-11-19 22:20:00 +00:00
2024-02-10 15:22:18 +00:00
`QueryProfile`, `ClientQuestLogin`, `MarkItemSeen`, `SetItemFavoriteStatusBatch`, `EquipBattleRoyaleCustomization`, `SetBattleRoyaleBanner`, `SetCosmeticLockerSlot`, `SetCosmeticLockerBanner`, `SetCosmeticLockerName`, `CopyCosmeticLoadout`, `DeleteCosmeticLoadout`, `PurchaseCatalogEntry`, `GiftCatalogEntry`, `RemoveGiftBox`, `RefundMtxPurchase`, `SetAffiliateName`, `SetReceiveGiftsEnabled`
2023-12-31 15:09:21 +00:00
## Support
2023-11-05 02:20:40 +00:00
2024-01-21 00:50:54 +00:00
- **[Discord Server](https://discord.gg/kBefMZA4Qp)** Get help from community members!
2023-10-31 22:40:14 +00:00
## Contributing
2024-02-14 22:20:17 +00:00
Contributions are welcome! Please open an issue or pull request if you would like to contribute. Make sure to follow the same formatting and to keep commits concise and readable e.g. do not change line indents to mess up code review!