Solved Getting started in plugin development?

I'm wanting to start creating some plugins and there doesn't seem to be a lot of information on it, or at least, not much I can find.

So I have a few questions.

1. Where can I find plugin development tutorials and information?
2. How do I get things like an Entity List from Rust?
3. How do I know what kind of data is in a hook like OnPlayerDisconnect, what data is stored in the BasePlayer player?
4. What language is the best to develop a plugin in and why? I know Javascript, but I can learn any of them as need be.

 

1. You don't as they don't exist, the best you can do is look at current plugins and http://docs.oxidemod.org/
2. Decompile the rust dlls with a tool like Justdecompile to figure out the methods rust uses and then just call them in your plugin.
3. Hook methods are http://docs.oxidemod.org/ and you'll need to use a tool like Justdecompile to decompile the rust dlls.
4. C# will give the best performance and allow for pretty much anything you want related to the server as you don't have to do workarounds like in other langs.

 

Awesome, thanks for the reply.

It's disappointing there is no real information on plugin development, perhaps I'll write something up after I've been working on it for a while.

I thought someone said doing something with the rust files, but I couldn't remember what it was. Seems all of the stuff I want to do I'm going to have to decompile the DLL's and learn it that way.

Thanks for the answer, I'm really surprised there isn't more information on plugins, and that there aren't more plugins overall. Rust doesn't seem too much further away than Minecraft was modding wise, so I'd figure there would be a flood of plugins.

 

I know this thread is as old as the Earth itself but it falls under the same topic;
---
Anyone knows the seed for a "development map"?
I'm thinking I don't need to load a big map full of ores, and trees, and animals when ... I won't really need any of that to develop (unless, ofc, if I'm developing something that interacts with those entities)

Or have I missed some configuration flag that tells the server to not spawn any of those things?

 

There is no trigger for that. I think the Rust devs have a development map but I don't believe it is accessible to us.

Why would you not want all of those things? If you want you can generate a 2000 map size to get a smaller map which will be faster to load if your worried about load times and lag.

 

Because I'm self-hosting the thing for development, instead of having it hosted;
I'm also thinking the load time needed to load everything in-house and then run the game on top of it would be gigantic - so, if I can lower those two (RC + a dev map) I can avoid using a client to test the code AND I have a low load-time for those reloads/restarts of debugging

Thanks Wulf! You've been a life-saver

 

Just so you know, you can reload oxide plugins with oxide.reload * to reload all plugins or oxide.reload pluginname in the console to reload plugins live. Restarting the server to see plugin changes is rarely necessary.

 

I am programming plugins in Python. I want to make sure I'm looking at the correct .dll files. As of now, I am in the following directory:
/RustDedicated_Data/Managed

The DLL I see other Oxide plugins importing classes/objects from the most (I'm assuming) is the "Assembly-CSharp.dll", is this the main DLL? Just want to make sure...

Also, does anyone know where I would copy the "Assembly-CSharp.dll" into, in order to use with my IDE so I can actually make sure I'm getting all the syntax correct for the various objects/classes e.g. "BasePlayer"? Is this even possible? I've never utilized another programming language DLL in tandem with Python.

Are there any Python programmers out there on Oxide that could give some pointers? I see an IronPython.dll file in the same "Managed" directory, should I be utilizing this DLL?

 

Yes, that's the main DLL.
It's probably possible to get auto complete for the types in that DLL with Python, but I don't do that, so I don't know. You'd probably have to look for autocomplete related to IronPython.
The IronPython DLL is just the extension DLL for IronPython, it isn't relevant for you.

 

I see, thank you sqroot. What do you do if you do not use auto-complete for the DLL? Have you just memorized it all? If you have, mad props to you.

 

I haven't. I'm running SublimeText2 without plugins and an ILSpy window with a Reflexil mod when writing plugins.
Kinda barebones, but it's enough for me.

 

Is "ILSpy" just a decompiler? Not familiar with it nor Reflexil. I think as I'm programming in Python, I can download the IronPython interpreter and that should do the trick...this whole game primarily runs around the .NET framework yes? Hence the ubiquity of C# mods right?

I've never stepped out of the Python bounds so many other languages and "frameworks" and how they function are extremely unfamiliar to me. As I'm slowly beginning to deduce all the intricacies of programming plugins for Rust/Oxide I'm creating a step-by-step tutorial for others who are fresh off the boat. Are there ways to create stickies or wiki pages for such things on the Oxide site? I've seen a lot of threads created posting the same general questions, but not a dedicated one for such matters.

 

.NET is just the C# (CLR) runtime and a bunch of libraries. Oxide allows you to use a subset of .NET.
I think the best way to improve documentation is not to have a bunch of stickies, but to improve the doc.
I've made a small waypoint here, maybe that helps as well: Classes | Oxide