Skip to content

Commit

Permalink
Feature/transaction shield (#4)
Browse files Browse the repository at this point in the history 
* config refactor

* ground scheduled deleted, one person one open inventory at a time

* Code comments and cleanup

* migrate from yarn to npm

* Adding input min/max limits

* Minor bugfixes to give and use items

* update new controller methods

* fixes + update to new character core apis

* Update readme
  • Loading branch information
@AndrewR3K
AndrewR3K committed Jun 19, 2024
1 parent a32a042 commit c5bdda5
Show file tree
Hide file tree
Showing 28 changed files with 12,738 additions and 6,966 deletions.
326 changes: 22 additions & 304 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,22 @@ Feather inventory is designed to provide a realistic and immersive inventory sys

## Features

1. **Weight-based Inventory System**: Items in the inventory have weight values, ensuring players need to manage their inventory space carefully.

2. **Player-to-Player Robbery**: Players can interact with each other to initiate robberies. The script will handle the mechanics and transfer of items between the two players involved.

3. **Usable Items**: The inventory system supports registering usable items, such as consumables or items that trigger specific actions when used.

4. **Custom Inventory API**: Developers can easily register custom inventories for different entities within the game, expanding the functionality of the script to cater to specific gameplay scenarios.
1. **Player inventory**: Provides players with an inventory
2. **Secondary/Custom inventory**: Developers can utilize the API provided by the script to register custom inventories for various entities within the game. This feature allows for expanded gameplay possibilities, such as creating unique loot systems or interactive objects.
3. **Ground inventory**: A global ground inventory for when players drop items
4. **Usable Items**: The inventory system supports registering usable items, such as consumables or items that trigger specific actions when used.
5. **Custom Inventory API**: Developers can easily register custom inventories for different entities within the game, expanding the functionality of the script to cater to specific gameplay scenarios.

## Getting Started

Follow these steps to set up the RedM inventory script in your server:

1. **Prerequisites**: Download the latest release from [Releases](https://github.com/DavFount/feather-inventory/releases)

2. **Installation**: Place the script files in your RedM server's resource folder. Ensure the feather-inventory in your [RESOURCE CONFIG FILE]

3. **Dependencies**: Feather Core - Feather core is the only dependency as of now.

4. **Configuration**: Adjust the settings in the configuration file to suit your server's gameplay style and preferences.

5. **Database Setup**: The database should be created for you automatically. If you are having issues please delete the table and restart the script.

## Usage

### Accessing Inventory

Players can access their inventory by pressing the [Inventory Key].

### Managing Items

1. **Adding Items**: Players can acquire new items through various means like looting, purchasing, receiving them as rewards, or trading with other players.

2. **Dropping Items**: Players can drop items from their inventory if they no longer need them.

3. **Using Items**: Usable items can be activated from the inventory to trigger specific actions or effects. Activate items by double clicking or dragging to use. If they are in your action slots 1-6 (6 is located at the bottom of the inventory) you can use the item by clicking those numbers.

4. **Weighing Inventory**: The inventory system will calculate and display the total weight of the items in the player's inventory.

### Player-to-Player Robbery

Players can initiate a robbery against another player by using an [Robbery Key]. The script will handle the interaction between the two players and transfer items accordingly.

### Custom Inventories

Developers can utilize the API provided by the script to register custom inventories for various entities within the game. This feature allows for expanded gameplay possibilities, such as creating unique loot systems or interactive objects.

## API Documentation

Expand All @@ -61,276 +32,7 @@ FeatherInventory = exports['feather-inventory'].initiate()
```

#### Server Side Inventory API

##### Register Foreign Key

Registers a Inventory Foreign Key for your script to utilize custom inventories.

| Parameter | Description |
| -------------- | ------------------------------------------------------------------------------------------- |
| tableName | This must be the exact name of your table where the inventory owner will be. (e.g. stables) |
| foreignKeyType | The data type used in your tables primary key. (e.g. BIGINT UNSIGNED, VARCHAR(255), INT) |
| primaryKeyName | The name of your primary key. (e.g. id) |

###### Example Usage

```lua
FeatherInventory.RegisterForeignKey('stables', 'BIGINT UNSIGNED', 'id')
```

##### Register Inventory

Registers a custom inventory for an entity.

| Parameter | Description |
| ---------------- | ------------------------------------------------------------------------------------------- |
| tableName | This must be the exact name of your table where the inventory owner will be. (e.g. stables) |
| id | The Owners ID from the database (e.g. the database ID of the horse) |
| maxWeight | Override the max weight for the inventory. (Pass nil to use config value) |
| restrictedItems | Table of item names from the DB that you'd like to be restricted (Pass nil to no restrict) |
| ignoreItemLimits | true to ignore the max quantity of the item or false to adhear |

###### Example Usage

```lua
-- Accept all defaults
FeatherInventory.RegisterInventory('stables', 6)

-- Override defaults
FeatherInventory.RegisterInventory('stables', 6, 2500, {'apple', 'haycube'}, true)

-- No Restrictions
FeatherInventory.RegisterInventory('stables', 6, 2500, nil, true)

-- Adhear to item limits. And don't restrict items
FeatherInventory.RegisterInventory('stables', 6, 2500, nil, false)
```

##### Inventory Can Hold

Verifies that the inventory you're attempting to put items in to can hold the specified items and quantity.

| Parameter | Description |
| ----------- | ---------------------------------------------------- |
| items | Table of item names and quanity you're trying to add |
| inventoryId | UUID of the inventory you are trying to add to |

###### Return Value

This will return a table with the response from the API letting you know why it didn't work.

```lua
-- Failed Example
local returnValue = {
status = false,
-- One of the following messages.
reason = 'Item is restricted.' -- First check
reason = 'Max quantity exceeded.' -- Second check
reason = 'Max weight exceeded.' -- Third check
}

-- Successful Example
local returnValue = {
status = true,
reason = ''
}
```

###### Example Usage

```lua
local items = {
{
item = "fangs",
quantity = 5
},
{
item = "meat",
quantity = 10
}
}

FeatherInventory.InventoryCanHold(items, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
```

#### Client Side API

- None at the moment

#### Server Side Items API

##### Add Item

Add an item to a given inventory.

| Parameter | Description |
| ----------- | ------------------------------------------------------ |
| itemName | The name of the item from the database. |
| quantity | The quantity of the item you'd like to add. |
| metadata | Any metadata you'd like to add to the item. Can be nil |
| inventoryId | The UUID of the inventory you are adding the item to. |

###### Example Usage

```lua
-- Add 6 apples to my inventory
FeatherInventory.AddItem('item_apple', 6, nil, 'c770bc77-3a77-11ee-b67f-18c04d04db03')

local metadata = { quality = 'poor', durability = 50, maxDurability = 100 }
FeatherInventory.AddItem('item_apple', 6, metadata, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
```

##### Remove Item By Name

Remove an item from a given inventory by name.

| Parameter | Description |
| ----------- | ------------------------------------------------------- |
| itemName | The name of the item from the database. |
| quantity | The quantity of the item you'd like to remove. |
| inventoryId | The UUID of the inventory you are removing the item to. |

###### Example Usage

```lua
FeatherInventory.RemoveItemByName('item_apple', 6)
```

##### Remove Item By ID

Remove an item by its inventory ID. Only supports a single item as its targeting the primary key of the table. If you need to remove multiple items use RemoveItemByName.

| Parameter | Description |
| --------- | -------------------------------------------------- |
| id | The ID of the item from the inventory_items table. |

###### Example Usage

```lua
FeatherInventory.RemoveItemById(6)
```

##### Set Metadata

Sets the metadata for a given item.

| Parameter | Description |
| --------- | -------------------------------------------------- |
| id | The ID of the item from the inventory_items table. |
| metadata | Table of key/value pairs to set |

###### Example Usage

```lua
local metadata = {
display = 'Something to display under the item description',
quality = 'poor',
durability = 50,
maxDurability = 100
}
FeatherInventory.SetMetadata(6, metadata)
```

##### Get Item

Gets an item from the Inventory Items Table

| Parameter | Description |
| --------- | -------------------------------------------------- |
| id | The ID of the item from the inventory_items table. |

###### Example Usage

```lua
FeatherInventory.GetItem(6)
```

##### GetItemCount

Retrieves the amount of a specific item a player has. Returns the quantity.

| Parameter | Description |
| ----------- | ----------------------------------------- |
| itemName | The name of the item you are looking for. |
| inventoryId | ID of the inventory |

###### Example Usage

```lua
FeatherInventory.GetItemCount('item_train_ticket', 'c770bc77-3a77-11ee-b67f-18c04d04db03')
```

##### Item Exists

Checks if an item exists in the DB.

| Parameter | Description |
| --------- | ----------------------------------------- |
| itemName | The name of the item you are looking for. |

###### Example Usage

```lua
FeatherInventory.ItemExists('item_train_ticket')
```

##### Inventory Has Items

Checks if

| Parameter | Description |
| --------- | ----------------------------------------- |
| itemName | The name of the item you are looking for. |

###### Example Usage

```lua
FeatherInventory.ItemExists('item_train_ticket')
```

##### Inventory Has Item

Checks to see if a player has a specific item or items.

| Parameter | Description |
| --------- | ---------------------------------------------------------------------------------------------------- |
| items | A table of items you wish to check for. See below for an example of a properly formatted item table. |
| inventory | The inventory ID you're checking to see if it has items against. |

###### Example Usage

```lua
local itemsToCheckFor = {
{
name = 'apple',
quantity = 5
},
{
name = 'jars',
quantity = 2
}
}

FeatherInventory.PlayerHasItems(itemsToCheckFor, 'c770bc77-3a77-11ee-b67f-18c04d04db03')
```

##### Register Usable Item

Registers a usable item with Feather Inventory.

| Parameter | Description |
| --------- | --------------------------------------------------------------- |
| itemName | The name of the item you are registering a call back for. |
| callback | A closure with the logic you will be using upon use of the item |

###### Example Usage

```lua

FeatherInventory.RegisterUsableItem('item_apple', function (item)
print('You ate an apple!')
end)
```
Link TBD

## Troubleshooting

Expand All @@ -347,3 +49,19 @@ This inventory script is licensed under GPL3 License. Refer to the LICENSE file
## Credits

Huge inspiration to RDO's inventory system with many QOL improvements.

## To-Do

- Add LOD to load ground items within a view distance
- Make character initiate loadscreen text configurable.
- Migrate all language/text to locales
- Make secondary inventory titles customizable
- Frontend UI
- Add Inventory specific slot counts
- Account for inventory specific ignore limits (ignore item caps)

### Next version improvements

- Frontend UI
- Migrate frontend to use state management.
- Shift + Drag will transfer or drop all items (no modal displays in this case.)
9 changes: 7 additions & 2 deletions client/controllers/inventory.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ InventoryAction = {}
function CanOpenInventory()
if IsEntityDead(PlayerPedId()) then return false end
if IsPauseMenuActive() then return false end
-- Add check for different states where inventory can't open like Handcuffed/HogTied/KnockedOut
-- TODO: Add check for different states where inventory can't open like Handcuffed/HogTied/KnockedOut
return true
end

Expand All @@ -17,9 +17,14 @@ InventoryAction.Open = function(otherInventoryId, target)

print('Opening Inventory', otherInventoryId or 'character')
if not isInvOpen and CanOpenInventory() then
local results = Feather.RPC.CallAsync('Feather:Inventory:GetInventoryItems', { otherInventoryId = otherInventoryId })
if results.error ~= nil then
Feather.Notify.RightNotify(results.error, 3000)
return
end

isInvOpen = true

local results = Feather.RPC.CallAsync('Feather:Inventory:GetInventoryItems', { otherInventoryId = otherInventoryId })
local player_display = Feather.RPC.CallAsync('Feather:Inventory:GetCharacterInfoForDisplay')

SendNUIMessage({
Expand Down
0 client/coreapi.lua → client/imports.lua
View file
File renamed without changes.
4 changes: 2 additions & 2 deletions client/main.lua
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Feather = exports['feather-core'].initiate()
ClientReady = false

local function makeReady()
local function runInventory()
StartAPI()
ClientReady = true
end

makeReady()
runInventory()

0 comments on commit c5bdda5

Please sign in to comment.