Creators Guide Project - Looking for Contributors

FiveM Discussion
, ,
1

Hey all.

I’ve got a good idea, I’m gonna do it, but it will go a lot faster with YOUR HELP! (yes you…) BASICALLY:

A… Fully-Inclusive, Semi-Crowdsourced, All-Encompassing, Well-Designed, Located-in-one-place, All-you-can-eat, Kick-Ass, FREE… GTA/FIVEM CREATORS GUIDE/PUBLICATION!

READ MORE! (Or if you're sold already just skip this)

  • Really though, as a new-ish FiveM User who is learning the ropes of development, there’s not a single thing I would like along the way than a single document/website I can go to to find everything from the tiny details that no one ever talks about to the things that are so obvious that no one ever talks about them.

  • I say “Semi-Crowdsourced” because (at least initially) it will be a little selective who gets to work on it, just to prevent trolling and bad information, but it will be open to any developer who has experience and wants to help.

  • If my explanation has sucked so far what I want to create is a free guide that is available to everyone and is frequently updated with new discoveries and provides all of the useful information you need for development in one spot.

You don’t have to be an expert on everything, just on something, or even just on the basics, any contribution is hugely appreciated and will get you a spot in the credits and the history books.

  1. Add Floh
  2. Get Added to Documents
  3. Write about stuff you know
  4. ???
  5. Profit??

IF YOU WANT TO HELP :sunglasses:, GET MORE DETAILS :thinking:, OR EVEN JUST WATCH :smirk: ADD ME :smiley:
Floh#7952

In all seriousness, I think this would be great for a lot of people. Thank you for reading, I hope I’m not breaking any rules. <3

[edit] … and yes, I know about http://docs.fivem.net/. I find that it’s directed toward actual development of resources and scripts, rather than server development or customization. Also there’s nothing about popular frameworks or mods :slight_smile: (which is understandable but should be addressed somehow somewhere)

2

docs.fivem.net is what you mean?

3

But with parts geared toward newer people, and with a focus on customization of resources and files rather than primarily setting up files and documenting which files exist.

And with just more in general. I find those pages to not be exceptionally helpful.

There’s hours and hours of research and discoveries that people have made that aren’t included there.

People have different methods, people have better/worse ideas. All of which could be valuable.

It will reference these pages, and elaborate and expand.

4

Well the docs website isn’t finished and I believe there will be a way to submit improvements once the repository is set up.
The docs website doesn’t have to just be about “official” information.
Not sure what the rest of the community thinks about having pages for popular frameworks, but if anything, they should be documented by the developers and put on their github page (github has a built-in wiki for repositories as well)

As far as I understand it, docs.fivem.net is used to document everything related to the FiveM mod. Anything related to frameworks, scripts, etc that are built for FiveM are posted on the forums and on the creators github.
That way the docs website doesn’t get filled with outdated information or clogged with random scripts and frameworks.

By all means, you could create a website to help inform people on the latest scripts and frameworks and include tutorials. But the idea should be that each script developer provides some decent documentation, especially for frameworks.

1 Like
5

Hadn’t thought about keeping the content about frameworks and things like that up to date, maybe something else can be figured out for that.

In general though, I don’t think their docs page will reach the level of tutorials on things like vehicle skinning and resource customization that I hope this project will. It’s just too focused on being a list of references for experienced developers and script devs over being a guide for the smaller stuff that goes unmentioned.

As an example of what I mean the docs page simply states that carvariations, handling, carcols, and vehicles meta files exist and provides some details and reference hashes. I hope to gather in depth information and tutorials for each file individually to help people create/modify their own.

The way I have my project outlined right now, it actually works quite nicely as a precursor to the FiveM Docs page, ending with “Scripting basics” and covering all of the basics of resources, vehicles, and server setup, as well as client-side customization.

Either way, can’t hurt to have more than one source to reference, and I think it will be a fun project.

6

Which is exactly what the docs are there for. Beginners, as well as more advanced developers. You probably haven’t seen the recent updates to the docs.

It’s a work in progress, besides, soon there will be ways for anyone to create pull-requests to add more info on there anyway.

Probably because a lot of it is not really directly related to FiveM directly, more suited for something like a “GTA V mod docs” site.

If you’ve got ideas on how to improve our current docs, you will soon be able to create pull-requests, but for now you can always let us know and we’ll take a look.

Can you explain? The docs are all about providing guides for new users/developers as well as providing the references of functions/features that devs and users can use.

Yeah FiveM will never support editing existing resources, because

  1. that’d literally be impossible to maintain the infinite amount of resources out there.
  2. even if everything was documented about every resource, then people would still always ask about tiny details not covered on there (as well as just ask things anyway even if they are documented on there).
  3. a lot of resources actually have licenses limiting you in what you can edit. There’s usually no need to edit every resource completely, simply requesting a feature from the original developer is usually better because they know exactly what they’ve made, and how to implement this new feature in the same way existing features are already added.

“level of tutorials” what?
Also, vehicle skinning and resource customization is definitely not something FiveM docs would need.
Might as well create a full photoshop 101 guide on the docs as well if we’re going to add skin creation tutorials.

Again, I believe you have not seen the recent changes on there. There’s a lot of new info added for new users.

Those files are already documented on many other sites, for example this one.

It’s completely fine to have your own references or docs. I’m not going to argue about that. Just think that you maybe misunderstood what the FiveM docs are, what they should be and what they will be in the (near) future.

1 Like
7

I have, and as an absolute beginner with any sort of server development experience, I haven’t really found anything there helpful to me aside from the list of control hashes which I have referenced probably 6-10 times.

Don’t get me wrong, it seems to be an excellent resource for learning about scripting for FiveM, but in terms of server development I had to go elsewhere (and everywhere) to learn.

The server setup section and installation section would undoubtedly be useful to people pursuing those things, but as far as server development goes, beginners are left in the dark. People don’t go from setting up a server to creating their own scripts and the area between is what seems to be missing.

I noticed the WIP resources category, seems like a step in the right direction :smiley: .

I do understand why individual resources can’t be covered in the format of FiveM Documents though.

That should be awesome.

This is a good point, I never considered this. I guess the purpose of my idea can be adjusted to providing a link between the two, providing tutorials for more GTA based changes.

I see nothing wrong with this. That’s basically what I want to do, it doesn’t have to be a completely 100% comprehensive experts guide to Photoshop, but it will be “Skinning In Photoshop 101” Covering what is needed to help people learn how to do it.
As far as photoshop goes, skinning requires almost no experience to accomplish, it might take you a lot longer if you’re new, and maybe your skins won’t be top notch, but anyone can do it (and it doesn’t need to be Photoshop).

I realize that wouldn’t have a place on the FiveM documents, so maybe that falls into the category of what might be different between what I’m planning and the official documents.

Yeah and it’s excellent work, props to the authors of stuff like this. However, having these things as part of a cohesive tutorial, and compiled in one place would be incredibly helpful.

I don’t mean to sound as if I’m bashing the documentation page, but either through my own fault, or lack of inclusion, I wasn’t able to find the help I needed there, and that is the gap I seek to fill.

In the future even if both the official documentation and my own project are successful/finished and turn out to contain exactly the same content, which they almost certainly won’t, it wouldn’t do anything but help the community.

Thanks for replying, love your work.

I’ve updated the original post to more accurately reflect the role of my project according to your points :smiley:

1 Like
8

Just one final thing i’d like to repeat: if you have some great topics that would fit on the official docs, let me know :wink:

9

What criteria exactly would those “great topics” have to fall under haha

10

Specific to “FiveM”. So anything that explains FiveM specific features or dev API’s related to FiveM.

1 Like