TFS Documentation about forgottenserver HOT 20 CLOSED

It should be done in the Wiki, here: https://github.com/otland/forgottenserver/wiki

from forgottenserver.

Alright, I can do that. Is there a specific structure on Wiki that you would like?
Like, right now you have all the Compiling stuff right on the front page of Wiki, do you have a plan for a better organization?

from forgottenserver.

An index page with a brief description how Lua is used in the project. A page for each metatable (Position, Player, etc.) we have with their respective functions documented, also don't forget about inherited functions (you could have a link to Creature from Player and write that it also inherits the functions from Creature). The index page should also link to the metatable pages.

The front page of the Wiki will of course also be updated when there are more pages.

from forgottenserver.

Somebody help me? I compiled TFS and open it correctly put my IP on the client 10.31 of Tibia, I use IP Changer but when I log in it says the login is incorrect but it is not! The TFS has connected just right with the MySQL database and only has an account in the db, and when I close the TFS client and try to log in it gives the error 10600, then the IP Changer works because when I close the TFS it does not give invalid account, help please! Sorry my English!

from forgottenserver.

Your passwords must be SHA-1 hashed. If they are currently in plain-text, you can use this MySQL query to hash them:

UPDATE `accounts` SET `password` = SHA1(`password`)

from forgottenserver.

Thank you! I'll try.
---- Update: It worked! Thank you!

from forgottenserver.

One more thing, how do I change the sex of the character? I changed the value of sex in the table players and is still the char as female, can you help me?

from forgottenserver.

You cannot do any changes while your character is online. Firstly, you have to log off and later you can modify values in database.

Also (as far as I know) 0 means female and 1 means male.

from forgottenserver.

It worked! Thank you kamilwaz!

from forgottenserver.

I created a character in the database with "group_id = 3", only when I run the command "/reload npc" this message appears: "You can not execute this command.". Somebody help me? Thank you in advance.

from forgottenserver.

Please stop using this issue as your support forum. If you just need help with something, use the Support forum on OTLand: http://otland.net/forums/support.16/. If you have a question that could potentially be a issue in TFS, start a new issue about it.

from forgottenserver.

@marksamman Oh, sorry! I'm new on Github and did not know where to ask.

from forgottenserver.

Is somebody responsible for documentation? If not, I can try but and yet I don't write English very well.

from forgottenserver.

@EvanMC was working on it in the Wiki in his fork. I don't know the status of that though. The documentation is menat to be in our Wiki. If you want to work on it, do so in the Wiki in your fork and just comment here when you want us to copy a page to the Wiki of this repository (for example if you've documented the Combat metatable).

from forgottenserver.

I was working on it, I just have not gotten the time to update it and all that.
If you want to fork my Wiki, you are free to do so. https://github.com/EvanMC/forgottenserver/wiki

Dalkon made a simple script that is used as a talkaction that would simply structure and generate a simple Wiki code for a specific metatable, but it requires work and a lot of copying and pasting. This is not the best script available, I'm sure I could get something much better with Perl or whatever, again, I just need to find that time!

Here's Dalkon's script: http://pastebin.com/msvVh6bM
(As you notice at the top, it's set for the Tile metatable, then in content, these are the list of methods for Tile).
Again, I've mentioned before, it needs improvement and can easily be done.

Sorry!
Evan

from forgottenserver.

Only the lua metatables would be documented? What about the functions in global and compat files?

from forgottenserver.

Functions in compat should not be documented. Using them is discouraged and they may become deprecated/removed in the future.

from forgottenserver.

all right then, i'll start working on it when I get home. 👍

from forgottenserver.

@dalkon wrote a script that generates Wiki pages with all the functions so that you only need to fill in parameters, return value, description and example. You should use that to start off if you can get ahold of him.

from forgottenserver.

@dalkon has laid the groundwork for this in the Wiki, which is satisfying enough to close this issue. If anyone is interested in helping out further with documentation, please open an issue and link to the updated pages in your fork and I'll merge them into the Wiki on this repository.

from forgottenserver.