Merge pull request #4 from yawaflua/yawaflua-patch-3

Update README.md
This commit is contained in:
Dima yawaflua Andreev
2024-02-25 20:19:44 +03:00
committed by GitHub

View File

@@ -1,4 +1,7 @@
# SPWorldsWrapper
# ⚠ DEPRECATED ⚠
Разработчики spworlds ввели динамичные токены, которые обновляются постоянно, из-за чего использование данной библиотеки вместе с использованием сайта, даже через VPN стало невозможным.
## SPWorldsWrapper
![](https://img.shields.io/badge/dotnet-.NET_7-green)
Actions pass:
@@ -11,16 +14,16 @@ Actions pass:
- Добавлять/удалять города на карте(ПРИ НАЛИЧИИ РОЛИ КАРТОГРАФА)
- Получать любые данные, используя HttpClient, внутри класса
# Установка
## Установка
```cli
dotnet add package SPWorldsWrapper
```
# Добавление функций
## Добавление функций
Если вы хотите помочь с разработкой, просьба создать Pull Request, где будет созданы нужные методы и, желательно, комментарии к ним.
Если вы хотите помочь с расширением этого wrapper`a, просьба создать Issue, где вы подробно изложите, что именно вам надо.
# Использование
## Использование
## Перевод игроку, имея только никнейм
Ниже есть пример использования. В ходе этого примера мы переводим игроку 1 АР, получая карту по никнейму, а потом переводя на нее ары(через [библиотеку](https://github.com/Mih4n/spworlds-csharp-library)).
```cs
@@ -38,6 +41,6 @@ SPWorlds sp = new SPworlds("[ваш айди]","[ваш токен]");
SPUser user = await wrapper.getUserData("yawaflua");
sp.CreateTransaction(user.CardsOwned.First().number, 1, "Привет от yawaflua")
```
# FAQ
## FAQ
- Где получить токен для использования? - [тут](https://github.com/yawaflua/SPWorldsWrapper/blob/master/GETTOKEN.md)
- Как сделать так, чтобы токен не слетал? - Надо использовать впн, с выходной точкой в виде вашего сервера. Я использую [tailscale](https://tailscale.com/), но в России его больше нельзя скачать. Можно попробовать настроить OpenVPN или иные сервисы. [Тут](https://habr.com/ru/companies/ruvds/articles/726718/) например описано, как можно легко поднять с помощью сервиса RuVDS, где вы получите и VPN, и VDS. Я бы не советовал исполользовать RuVDS из-за большой стоимость и ужасного качества поддержки и серверов, но это выбор каждого.