PivityGmodStore

Creating your own potions

So, you wanna make a pack of potions huh? Well let's clear up a few things first of all:

  1. I do NOT permit you to sell these. They must be free, preferably on Github or Garrysmods.org or something. (I don't mind if you make your own custom potions for your server, this only applies to people who wish to distribute them). If your restricting potions to certain VIP groups that require payment that's fine.
  2. If you do not own the addon, please, don't try. You won't be able to test them and they probably won't work.
  3. Two potions cannot share a recipe. To prevent conflictions, please, use your own chemicals as much as possible.


Okay, now that that's over with. Let's get into the juicy stuff.


The basic file structure for a new addon containing potions is like this:

📁 my_addon_folder

  1. 📁 lua
  2. 📁 wizardry
  3. 📁 items
  4. 📁 my_addon_name
  5. 📁 chemicals
  6. 📝 sh_chemical_one.lua
  7. 📝 sh_chemical_two.lua
  8. 📁 potions
  9. 📝 sh_potion_one.lua
  10. 📝 sh_potion_two.lua


Notice the sh_ in front of every file. This is how wizardry's autoloader works. It tells the addon to load it shared. If you don't do this, the addon won't load your potion.


Chemicals

To create a new chemical, go into your addon's chemicals folder and create a new file. Call it anything, as long as it has sh_ in front of it, although it's preferable to name this something special to your chemical. E.g sh_body_part.lua or something.

Here is a basic example of the code for a new Chemical from the base addon. Don't worry, I'll walk you through it.

local CHEMICAL = Wizardry.Objects.NewChemical("wizardry.organsoup")
CHEMICAL:SetName("Organ Soup")
CHEMICAL:SetDescription("Random organs mashed up into some kind of soupy substance. I wouldn't reccomend comsuming it though.")
CHEMICAL:SetPrice(1500)
CHEMICAL:Define()


First, we need to define a new Chemical object. This is done using Wizardry.Objects.NewChemical(id). The ID must be something that is unique to your addon and chemical, as this is how the addon is able to differentiate between two different chemicals. If your ID is not unique and clashes with another chemical, the addon will refuse to load your chemical.

So, let's create our chemical object.

local CHEMICAL = Wizardry.Objects.NewChemical("myaddon.bodyparts") -- Define a new Chemical and give it a unique ID.

Now, we need to define it's information. Chemicals have a Name, Description, and a Price. We can define these using the representative functions on the chemical object we just created.

CHEMICAL:SetName("Body Parts") -- The name of our chemical that is shown to the player.
CHEMICAL:SetDescription("Mushed up Body Parts from some guy we found laying on the streets.") -- The description of the chemical.
CHEMICAL:SetPrice(2500) -- The price to buy the chemical from the Chemical Engineer.

Now, we simply need to call CHEMICAL:Define(). This function checks everything is valid in the chemical, and if everything is in order, register it.

CHEMICAL:Define() -- Lets the addon know we want to register it.

Assuming everything is good, your chemical should now be registered successfully by the addon on server startup. :)

Here's the example in full:

local CHEMICAL = Wizardry.Objects.NewChemical("myaddon.bodyparts") -- Define a new Chemical and give it a unique ID.
CHEMICAL:SetName("Body Parts") -- The name of our chemical that is shown to the player.
CHEMICAL:SetDescription("Mushed up Body Parts from some guy we found laying on the streets.") -- The description of the chemical.
CHEMICAL:SetPrice(2500) -- The price to buy the chemical from the Chemical Engineer.
CHEMICAL:Define() -- Lets the addon know we want to register it.


Potions

Potions, while harder, are still quite easy. For this example, we're going to make a potion that will decrease the player's walk speed. Quite pointless, but I'm only using this as an example.

Here is a basic example of a Potion from the base addon itself:

local POTION = Wizardry.Objects.NewPotion("wizardry.core.health.one")
POTION:SetName("Health I")
POTION:SetDescription("Gives you back a small amount of health.")
POTION:SetEffectTime(5)
POTION:SetColor(Color(232, 31, 67))
POTION:SetStirAmount(30)


POTION.effects = {
"Regenerates 3 hp per second for 5 seconds.",
}
POTION.recipe = {
["wizardry.blood"] = 3,
}


POTION:Define()


function POTION:DrinkSV(ply)
timer.Create("wizardry.potions.healthone." .. ply:SteamID64() .. ".timer", 1, 5, function()
ply:SetHealth(math.Min(ply:GetMaxHealth(), ply:Health() + 3))
end)
end


First thing we need to do when we create a new potion, is like the chemicals define a new Potion Object. Once again, we need to give it a unique ID so the addon can tell the difference between two potions.

local POTION = Wizardry.Objects.NewPotion("myaddon.crudestealth") -- Define a new Potion and give it a unique ID.

And, like the chemicals, we need to set it's data. We need to set it's name, description, the effect time (the time the potion is effective), the color and how much you need to stir it in the cauldron.

POTION:SetName("Crude Stealth") -- The name that is shown to the player.
POTION:SetDescription("Crudely gives you a slower movement to help with stealth. This is done by strapping body parts to the side of your legs. Sounds dark, but don't worry, it's only horrifying to you for the rest of your life!") -- The... dark... description of the potion.
POTION:SetEffectTime(15) -- The time in seconds the potion if effective for, before we reset the player back to normal.
POTION:SetColor(Color(200, 200, 200)) -- The color of the Potion. This only really affects the Drink Potion button.
POTION:SetStirAmount(50) -- How much we need to stir this in the cauldron.

Now, we need to define some effects and a recipe for it. Unfortunately, due to how Lua's crap implementation of OOP works, we need to define these tables manually instead of using fancy functions. The effects table is purely visual, and simply tells the player what happens to them when they drink the potion. The recipe is what the wizard places into the cauldron to make the potion. The recipe is made up of Chemicals, which are specified using their IDs. We'll use the Body Parts chemical we defined earlier.

POTION.effects = { -- Define our effects table.
"Slows your walking speed.", -- The effect.
} 
POTION.recipe = { -- Define our recipe table.
["myaddon.bodyparts"] = 2, -- Define a Chemical ID as the key, and the amount they need as the value. This potion needs two body parts for example.
}

Now that that's done, we need to let our potion know what to do when a player drinks it. This is done using two functions, on each side. DrinkSV(player), DesistSV(player) for serverside, and the twin DrinkCL() and DesistCL() for clientside stuff. All the drink functions are for applying affects, and is called when the player initially drinks the potion. The desist is for resetting the player back to normal, when the effect wares off or they die.

Remember: Never trust the client. Only use Clientside for visuals.

So, now that we know what functions to call, we can use them to slow our player.

function POTION:DrinkSV(ply) -- Define our function for when the player drinks the potion.
ply:SetWalkSpeed(100) -- DarkRP default is 160, so we'll set it to 100.
end
function POTION:DesistSV(ply) -- Define the function for when the effect needs to stop.
ply:SetWalkSpeed(160) -- 160 is the DarkRP default, so we'll reset it.
end

Now we've done that, we need to call POTION:Define() to let the addon check that our potion is good to go, and to add it to the game.

POTION:Define() -- Define it.

And, we should be done. If you load up the game, you should be able to buy bodyparts from the Chemical Engineer. Lob two of them into the Cauldron and you should get a potion that slows you down. That was easy, huh?

Full code for that Potion Example:

local POTION = Wizardry.Objects.NewPotion("myaddon.crudestealth") -- Define a new Potion and give it a unique ID.
POTION:SetName("Crude Stealth") -- The name that is shown to the player.
POTION:SetDescription("Crudely gives you a slower movement to help with stealth. This is done by strapping body parts to the side of your legs. Sounds dark, but don't worry, it's only horrifying to you for the rest of your life!") -- The... dark... description of the potion.
POTION:SetEffectTime(15) -- The time in seconds the potion if effective for, before we reset the player back to normal.
POTION:SetColor(Color(200, 200, 200)) -- The color of the Potion. This only really affects the Drink Potion button.
POTION:SetStirAmount(50) -- How much we need to stir this in the cauldron.

function POTION:DrinkSV(ply) -- Define our function for when the player drinks the potion.
ply:SetWalkSpeed(100) -- DarkRP default is 160, so we'll set it to 100.
end
function POTION:DesistSV(ply) -- Define the function for when the effect needs to stop.
ply:SetWalkSpeed(160) -- 160 is the DarkRP default, so we'll reset it.
end

POTION:Define() -- Define it.


Where can I upload my l33t potion pack now?

Anywhere, as long as it's free. :)

If you do upload it, shoot over a DM or support ticket with the link. I'm curious to see what you guys are making. I'll also add you to a list of people who've made potions for the addon on the addon page, so thats another bonus.

If you need help creating a potion, join my Discord Server. There is plenty of helpful people there who will help you out, including me!

Welp, I'm off to go and cry at how long this took to write. Bye!

Can't find what you're looking for?

Contact support

Submit a ticket