API Development Hub - Information, Resources & Guides

[LukeD 1858]

This thread will remain pinned and locked and used by moderation and management staff to maintain the API forum section. Please try to avoid pinning too many threads. Instead edit this hub thread with any information you deem relevant. If information is critical (i.e some things Cyan posts) it can be pinned, and added to the hub. Then unpinned later when it is no longer critical. The hub thread will then maintain the link to that thread.

Welcome to the API Development Forums
"Hello fellow developers. Welcome to our brand new LSPDFR API Development forum. Great to see you made it here! This is the place to ask questions about working with the API, as well as requesting features. More examples and proper documentation will follow soon as we focus on the mod itself currently. If you have any feedback regarding the very early API implementation though, feel free to share." - LMS

 

API Changes & Important Information

Download Centre API - Cyan
 - Documentation post for the newly introduced download centre API for update and version comparison and beta authorization.

New API Functions in LSPDFR 0.2a - Sam
 - Information regarding new API functionality provided by 0.2a

Keeping Users Safe - Cyan
 - Update information regarding the upload of plugins which contact personal servers or use .EXE programs

 

Resources

GitHub Repository (This link directs you to GitHub.com)
 - Link to the github repository. Here you can find developer resources such as custom classes to help you with development

Vector3Extension Class (This link directs you to pastebin.com)
 - Link to the C# code that was removed from public access in LSPDFR code, simply add this class to your own plugin to make use of functions like Around(start, radius) and DistanceTo(start, end)

API Quick Start Guide & Example Project
 - A quick start pdf guide and zip file containing a basic LSPDFR plugin solution, for use in Visual Studio

RagePluginHook Documentation (This link directs you straight to the RPH online documentation)
 - Online documentation for the Rage Plugin Hook

GTA V Prop List (This link directs you to a prop list, hosted on GitHub.com)
 - A list of all known GTA V prop model names

GTA V Natives Database (This link directs you to the GTA V Natives DB, hosted on dev-c.com)
 - GTA V Natives database created by Alexander Blade.

GTA Animations List (This link directs you to the ls-multiplayer website)
 - A larger list of all known animations in GTA V (It contains more than the RPH Documentation)

CoordSaverV - LtFlash
 - Downloadable tool that helps the process of manually collecting callout spawn points

Guides & Other Useful Topics

Standardisation of API Plugin Colours - AlconH
 - Thread detailing a universal colour scheme for text and blips for API developers to use when writing plugins

Guide to using the LSPDFR API & Documentation - Albo1125
 - A nice guide to making use of the LSPDFR API

Guide to Creating a Callouts Plugin - ToastinYou
 - A nice guide with images on how to create a callouts plugin with the LSPDFR API and RagePluginHook

LSPDFR Developers Discord Server - Stealth22 (This link directs to the Discord website, directly to the chat room)
 - A free chat client for LSPDFR developers to make use of for general chat, help and guidance.
This discord server uses a bot which requires the user to verify themselves as a developer in order to prevent general "my game is broke help" requests. 

Tips For Developers - Stealth22
 - A general thread of useful tips for all developers, whether you're new to programming or not.

 

General Guidelines For Using This Forum
Please adhere to these where possible, as they will help to keep the forum clean and useable. Remember that your posts act as information sources to users as well, not just means to get help.

•  Make use of title tags: [Solved] [Resource] [Guide] [Request] etc (I would recommend putting these at the start of your title)
•  Make sure your titles are crystal clear, not single words. Remember users may search for similar issues, you wouldn't search Google for "help" and hope one of the 4,890,000,000 results is the one you need.
•   Always put your log files either as an attachment or copied into a spoiler, similarly code snippets should be placed inside the code tags

 

Suggesting Content For This Hub Thread
If you have any suggestions for threads, resources or useful links that you think deserve to be highlighted in this thread please PM myself (LukeD) with your suggestion. Make sure you title your PM "API Dev Forum Idea" or similar so I can keep track of them. Alternatively you can direct message or tag me on the discord server mentioned above, please note I only respond to this on desktop however, so replies may be slow.

If you want to send me resources, be considerate of user safety and concerns regarding links.
•  Don't post advertising or shortened URL's, I want a full link to the resource that I can read.
•  Do give me a brief description of what you're sending, not just "hey this is useful".
•  Do provide reasons for why you think it's needed in the hub thread. The more you justify it the better.

In cases where you link a post or thread to me, I will parse that post for direct links. If I can avoid bouncing users around the forum I will. For example the discord server link above was taken out of Stealth22's post. Posts may then be subject to removal if necessary.

I will credit all links where applicable, all I'm doing is concatenating the information into one thread, credits are deserved for those providing the resources or guides.

 

This hub thread is an attempt at cutting down the increasing number of pinned threads. Please don't ask for threads to be pinned in this forum section. Only critical, need to know information will be pinned. After a while it will then be moved to this hub when it is no longer critical, but still useful.

 

This forum section is subject to moderation as per usual. Any thread that is linked in this hub however, will be exempt from the necro posting rules. As they will be acting as pinned threads (which are already exempt).

 

<iframe src="https://discordapp.com/widget?id=191266053861539840&theme=dark" width="350" height="500" allowtransparency="true" frameborder="0"></iframe>