Initial Deployment
This commit is contained in:
Patrick Ulrich
commit
91f9eb5746
21
LICENSE.txt
Normal file
21
LICENSE.txt
Normal file
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2024 Patrick Ulrich
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
1365
Orangemart.cs
Normal file
1365
Orangemart.cs
Normal file
File diff suppressed because it is too large
Load Diff
198
README.md
Normal file
198
README.md
Normal file
@ -0,0 +1,198 @@
|
||||
## Overview:
|
||||
The **Orangemart** plugin allows players on your Rust server to buy and sell in-game units and VIP status using Bitcoin payments through the Lightning Network. This plugin integrates LNBits into the game, enabling secure transactions for game items and services.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- **In-Game Currency Purchase:** Players can purchase in-game currency using Bitcoin payments.
|
||||
- **Send In-Game Currency:** Players can send currency to others, facilitating peer-to-peer transactions.
|
||||
- **VIP Status Purchase:** Players can purchase VIP status through Bitcoin payments, unlocking special privileges.
|
||||
- **Configurable:** Server admins can set up command names, currency items, prices, and more through the configuration file.
|
||||
|
||||
---
|
||||
|
||||
## Commands
|
||||
|
||||
The following commands are available to players:
|
||||
|
||||
- **`/buyblood`**
|
||||
Players can purchase in-game currency using Bitcoin. The amount purchased is configurable.
|
||||
|
||||
- **`/sendblood <amount> <targetPlayer>`**
|
||||
Players can send a specified amount of in-game currency to another player.
|
||||
|
||||
- **`/buyvip`**
|
||||
Players can purchase VIP status using Bitcoin. The VIP price and associated permission group are configurable.
|
||||
|
||||
---
|
||||
|
||||
# Orangemart Plugin Configuration
|
||||
|
||||
Below is a comprehensive list of key configuration variables that can be customized in the **Orangemart** plugin.
|
||||
These settings allow you to tailor the plugin's behavior to fit your server's requirements.
|
||||
|
||||
## Configuration
|
||||
|
||||
#### Commands
|
||||
|
||||
- **`BuyCurrencyCommandName`**
|
||||
- The command players use to purchase in-game currency. For example, `/buyblood`.
|
||||
|
||||
- **`SendCurrencyCommandName`**
|
||||
- The command players use to send in-game currency to other players. For example, `/sendblood`.
|
||||
|
||||
- **`BuyVipCommandName`**
|
||||
- The command players use to purchase VIP status. For example, `/buyvip`.
|
||||
|
||||
#### Currency Settings
|
||||
|
||||
- **`CurrencyItemID`**
|
||||
- The item ID used for in-game currency transactions.
|
||||
|
||||
- **`CurrencyName`**
|
||||
- The name of the in-game currency displayed to players.
|
||||
|
||||
- **`CurrencySkinID`**
|
||||
- The skin ID applied to the in-game currency items. Set to `0` for default skin.
|
||||
|
||||
- **`SatsPerCurrencyUnit`**
|
||||
- The conversion rate between satoshis and in-game currency units. Determines how many satoshis equal one unit of in-game currency.
|
||||
|
||||
- **`PricePerCurrencyUnit`**
|
||||
- The price (in satoshis) per unit of in-game currency.
|
||||
|
||||
#### Discord Integration
|
||||
|
||||
- **`DiscordChannelName`**
|
||||
- The name of the Discord channel where payment invoices will be posted.
|
||||
|
||||
- **`DiscordWebhookUrl`**
|
||||
- The Discord webhook URL used to send invoice notifications to the specified channel.
|
||||
|
||||
#### Invoice Settings
|
||||
|
||||
- **`BlacklistedDomains`**
|
||||
- A list of domains that are disallowed for use in Lightning addresses. Players cannot send currency to addresses from these domains.
|
||||
|
||||
- **`WhitelistedDomains`**
|
||||
- A list of domains that are exclusively allowed for use in Lightning addresses. If this list is populated, only addresses from these domains are permitted.
|
||||
|
||||
- **`CheckIntervalSeconds`**
|
||||
- The interval time (in seconds) for checking pending Bitcoin transactions.
|
||||
|
||||
- **`InvoiceTimeoutSeconds`**
|
||||
- The time (in seconds) after which an unpaid invoice expires.
|
||||
|
||||
- **`LNbitsApiKey`**
|
||||
- The API key for authenticating with your LNbits instance.
|
||||
|
||||
- **`LNbitsBaseUrl`**
|
||||
- The base URL of your LNbits instance.
|
||||
|
||||
- **`MaxRetries`**
|
||||
- The maximum number of retry attempts for checking invoice payments before considering them expired.
|
||||
|
||||
#### VIP Settings
|
||||
|
||||
Configure the VIP status purchase and permissions.
|
||||
|
||||
- **`VipPermissionGroup`**
|
||||
- The Oxide permission group that players are added to upon purchasing VIP status.
|
||||
|
||||
- **`VipPrice`**
|
||||
- The price (in satoshis) for players to purchase VIP status.
|
||||
|
||||
---
|
||||
|
||||
### Example Configuration Snippet
|
||||
|
||||
Here's how the configuration might look in your `config.json`:
|
||||
|
||||
```
|
||||
{
|
||||
"Commands": {
|
||||
"BuyCurrencyCommandName": "buyblood",
|
||||
"SendCurrencyCommandName": "sendblood",
|
||||
"BuyVipCommandName": "buyvip"
|
||||
},
|
||||
"CurrencySettings": {
|
||||
"CurrencyItemID": 1776460938,
|
||||
"CurrencyName": "blood",
|
||||
"CurrencySkinID": 0,
|
||||
"PricePerCurrencyUnit": 1,
|
||||
"SatsPerCurrencyUnit": 1
|
||||
},
|
||||
"Discord": {
|
||||
"DiscordChannelName": "mart",
|
||||
"DiscordWebhookUrl": "https://discord.com/api/webhooks/your_webhook_url"
|
||||
},
|
||||
"InvoiceSettings": {
|
||||
"BlacklistedDomains": ["example.com", "blacklisted.net"],
|
||||
"WhitelistedDomains": [],
|
||||
"CheckIntervalSeconds": 10,
|
||||
"InvoiceTimeoutSeconds": 300,
|
||||
"LNbitsApiKey": "your-lnbits-admin-api-key",
|
||||
"LNbitsBaseUrl": "https://your-lnbits-instance.com",
|
||||
"MaxRetries": 25
|
||||
},
|
||||
"VIPSettings": {
|
||||
"VipPermissionGroup": "vip",
|
||||
"VipPrice": 1000
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Note:**
|
||||
- Ensure that all URLs and API keys are correctly set to match your server and LNbits configurations.
|
||||
- Adjust the `BlacklistedDomains` and `WhitelistedDomains` according to your server's policies regarding Lightning addresses.
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
1. **Download the Plugin**
|
||||
Place the `Orangemart.cs` file in your server's `oxide/plugins` folder.
|
||||
|
||||
2. **Configuration**
|
||||
Modify the plugin’s configuration file to fit your server’s settings (currency item, prices, VIP group, etc.). The configuration file will be automatically generated upon running the plugin for the first time.
|
||||
|
||||
3. **Create VIP Group (Optional)**
|
||||
Create a VIP group to assign permssions to.
|
||||
|
||||
4. **Reload the Plugin**
|
||||
Once configured, reload the plugin using the command:
|
||||
```
|
||||
oxide.reload Orangemart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Permissions
|
||||
|
||||
The plugin uses the following permissions:
|
||||
|
||||
- **`orangemart.buycurrency`**
|
||||
Grants permission to players who are allowed to buy your currency item via Bitcoin.
|
||||
|
||||
- **`orangemart.sendcurrency`**
|
||||
Grants permission to players who are allowed to send Bitcoin for your in-game currency unit.
|
||||
|
||||
- **`orangemart.buyvip`**
|
||||
Grants permission to players to purchase VIP via Bitcoin.
|
||||
|
||||
---
|
||||
|
||||
## Logging and Troubleshooting
|
||||
|
||||
- **Logs:**
|
||||
Transaction details, such as purchases and currency sends, are logged for auditing purposes. Logs can be found in the `oxide/data/Orangemart` directory.
|
||||
|
||||
- **Troubleshooting:**
|
||||
If any issues arise, check the server logs for errors related to the plugin. Ensure that the configuration file is correctly set up and that Bitcoin payment services are running as expected.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
This plugin is licensed under the MIT License.
|
||||
Loading…
x
Reference in New Issue
Block a user