hottehead Posted January 18, 2015 Share Posted January 18, 2015 Im trying to find a documentation of the API? Is there any like for other languages or frameworks? In particular I tried to find the "Minimap:ShowArea" function which a lot of people use to reveal the map. I want to get an overview about how the minimap works. But I couldnt find this function at all. I have searched the whole DST folder with an external tool to find this string in any file, but had no luck. So, how am I supposed to get knowledge of the functionality offered? greetings hottehead Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/ Share on other sites More sharing options...
Heavenfall Posted January 18, 2015 Share Posted January 18, 2015 (edited) No, there isn't. Although most of the game code is in the lua files and not in the .exe. Edit: Of course the lua isn't documented either. Edited January 18, 2015 by Heavenfall Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603487 Share on other sites More sharing options...
SeriousCreeper Posted January 18, 2015 Share Posted January 18, 2015 I just started checking out how to mod and learning some more LUA but maybe the community can get together and start a documentation as a wiki or something? There are lots of methods where i don't really know what the parameters all do, would be cool to have this info in one place. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603529 Share on other sites More sharing options...
Nynten Posted January 19, 2015 Share Posted January 19, 2015 I just started checking out how to mod and learning some more LUA but maybe the community can get together and start a documentation as a wiki or something? There are lots of methods where i don't really know what the parameters all do, would be cool to have this info in one place.I like that idea, it would really be a good resource for modding. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603569 Share on other sites More sharing options...
hottehead Posted January 19, 2015 Author Share Posted January 19, 2015 Okay, so everyone would benefit from this I think. Question is how should we do it? A forum thread isnt suited for that.I found this tool: https://github.com/tripit/slate. Something like this would be cool I think. Everyone could create an account and fill in the stuff he knows. If someone knows a better tool which can be hosted in the web, please link it here. If the right tool is found, I'll host the application on my server. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603684 Share on other sites More sharing options...
SeriousCreeper Posted January 19, 2015 Share Posted January 19, 2015 Slate looks interesting (also makes me think of Slade Wilson aka the Deathstroke.. anyway). Might be worth giving it a shot! Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603805 Share on other sites More sharing options...
hottehead Posted January 20, 2015 Author Share Posted January 20, 2015 (edited) I gave it a shot this evening. You can see my template here http://hottehead.github.io/APIDocs. The repository is located at https://github.com/hottehead/APIDocs. You can fork and edit it if u want to try it, too. Documentation can be done with this tool as long as everyone sticks to some formatting rules, because it's only a few markdown files. The produced HTML is quite okay, not too good. I'll try to structure the document tomorrow evening to suit the Dont Starve structure. Edited January 20, 2015 by hottehead Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603886 Share on other sites More sharing options...
Nynten Posted January 20, 2015 Share Posted January 20, 2015 I gave it a shot this evening. You can see my template here http://hottehead.github.io/APIDocs. The repository is located at https://github.com/hottehead/APIDocs. You can fork and edit it if u want to try it, too. Documentation can be done with this tool as long as everyone sticks to some formatting rules, because it's only a few markdown files. The produced HTML is quite okay, not too good. I'll try to structure the document tomorrow evening to suit the Dont Starve structure. I've used github criminally little, but I'll definitely look into working on this. Seems like a good start way to go! Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-603949 Share on other sites More sharing options...
deleted Posted January 20, 2015 Share Posted January 20, 2015 Sounds like a great idea, I might contribute a little once its been set up. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-604087 Share on other sites More sharing options...
hottehead Posted January 25, 2015 Author Share Posted January 25, 2015 (edited) I figured that using GIT is too much effort for someone to contribute a few lines. I've setup a simple wordpress installation and wrote a basic structure with very little content so far. The wordpress theme is simply the default theme.I'd like to hear your opinion. Does this make sense? Would you contribute? http://128.199.40.198/wordpress/ Edited January 25, 2015 by hottehead Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-605810 Share on other sites More sharing options...
boardman94 Posted January 26, 2015 Share Posted January 26, 2015 I figured that using GIT is too much effort for someone to contribute a few lines. I've setup a simple wordpress installation and wrote a basic structure with very little content so far. The wordpress theme is simply the default theme.I'd like to hear your opinion. Does this make sense? Would you contribute? http://128.199.40.198/wordpress/ That looks fine. It is better than the current API because it exists. =) I would really get behind this. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606001 Share on other sites More sharing options...
Blueberrys Posted January 26, 2015 Share Posted January 26, 2015 @hottehead, I would definitely contribute.My biggest concern would be proper syntax highlighting. It may not seem like much, but it can make code significantly easier to skim through. I'm not aware how easy it will be to implement that with wordpress.Secondly, the theme does not match Dont Starve, and doesn't seem to be very code-oriented either.Regardless, anything is a good start. Those things can be improved in time. Tripit slate was rather appealing, though. If only there was a way to combine the ease of use with appealing functionality. ..current API because it exists Interesting. I haven't come across it till now and assumed there wasn't one at all after searching a bit. Do you have a link for it? I'd like to check it out.Just to confirm though, you are talking about an official API documentation, not just the API itself, right? Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606038 Share on other sites More sharing options...
boardman94 Posted January 26, 2015 Share Posted January 26, 2015 (edited) @BlueberrysSorry, I meant that his version was better then other versions because there are no other versions.It was a poor attempt at humor. Edited January 26, 2015 by boardman94 Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606041 Share on other sites More sharing options...
debugman18 Posted January 26, 2015 Share Posted January 26, 2015 Interesting. I haven't come across it till now and assumed there wasn't one at all after searching a bit. Do you have a link for it? I'd like to check it out.Just to confirm though, you are talking about an official API documentation, not just the API itself, right? Context is important. He said "It (this topic) is better than the current api, because it (this topic) exists." Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606043 Share on other sites More sharing options...
Blueberrys Posted January 26, 2015 Share Posted January 26, 2015 @BlueberrysSorry, I meant that his version was better then other versions because there are no other versions.It was a poor attempt at humor. Context is important. He said "It (this topic) is better than the current api, because it (this topic) exists." Oh, I see. Sorry about that. Makes much more sense that way, haha. Thanks for clarifying. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606047 Share on other sites More sharing options...
SeriousCreeper Posted January 26, 2015 Share Posted January 26, 2015 Yeah i don't know if the wordpress site would work, having something like Slate but not having to use git would be useful for people who don't know much about git. I think if we'd go with a wordpress style of thing, we might as well add it to dont starve wiki? (Maybe klei can create a separate modding/programming wiki). Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606061 Share on other sites More sharing options...
Blueberrys Posted January 26, 2015 Share Posted January 26, 2015 (edited) @SeriousCreeper,The only dont starve wiki I know of doesn't contain much information on mods at all. It's very out dated and pretty messy in that department. You do have a point though, we could just use a wiki, but I'd suggest using a new one dedicated to modding (perhaps using Dokuwiki?). It would be ideal if Klei creates it, but that might not happen any time soon. Edited January 26, 2015 by Blueberrys Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606075 Share on other sites More sharing options...
hottehead Posted January 26, 2015 Author Share Posted January 26, 2015 (edited) Yay, thanks for the response. Cool to see that you are interested! @Blueberrys:You are right, syntax highlighting is really important. I solved it by installing this plugin https://wordpress.org/plugins/crayon-syntax-highlighter/ and made a demo code here http://128.199.40.198/wordpress/?page_id=38 . Everyone can easily create this code blocks in the WP-Editor and almost everything is customizable in this plugin.I also installed the TablePress plugin https://wordpress.org/plugins/tablepress/ . This helps to create Tables of fields and methods.Overall I know wordpress and the theme isnt exactly suited for an API Doc. But I think its a good starting point and we could improve it over time together, i.e. make a better navigation structure. Furthermore wordpress is something I am quite experienced in, which reduces the time I need to make adjustements. Concerning Dokuwiki:Dokuwiki also is quite good. Im using it for another project. But overall it's a little more complex to keep the structure. I think unexperienced users would have problems getting started and may produce messy files which are hard to maintain. I want to make it as easy as possible so that everyone can contribute. Edited January 26, 2015 by hottehead Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606142 Share on other sites More sharing options...
Blueberrys Posted January 26, 2015 Share Posted January 26, 2015 @hottehead, awesome! It looks significantly better with the new plugins.Looking forward to seeing this completed. Finally a go-to place to find all API and modding information in a concise manner.Is this site meant to serve only as a demo, or can we start adding to it now? Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606320 Share on other sites More sharing options...
hottehead Posted January 27, 2015 Author Share Posted January 27, 2015 Thanks! =) This site actually is the real one. Just register and wait for me to approve. I activated approval because I dont want everyone to gain immediate access. After that you can start adding content, the basic structure should be clear I think.We will give it a proper URL in the near future. Need to talk with KLEI staff about what name we are allowed to pick. Have fun and Im excited about how we will develop this further. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606470 Share on other sites More sharing options...
Blueberrys Posted January 27, 2015 Share Posted January 27, 2015 @hottehead, good thinking. I registered as Blueberrys. We will give it a proper URL in the near future. Need to talk with KLEI staff about what name we are allowed to pick. That would be nice. They're usually pretty lenient on these things, so it shouldn't be an issue. Think of a good one then ask em. Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606481 Share on other sites More sharing options...
hottehead Posted January 27, 2015 Author Share Posted January 27, 2015 @hottehead, good thinking. I registered as Blueberrys. That would be nice. They're usually pretty lenient on these things, so it shouldn't be an issue. Think of a good one then ask em. I approved you blueberry. Did you get the registration email? Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606488 Share on other sites More sharing options...
Blueberrys Posted January 27, 2015 Share Posted January 27, 2015 @hottehead, I did not, actually. Could it be because I used an alias (+ symbol)? Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606541 Share on other sites More sharing options...
hottehead Posted January 28, 2015 Author Share Posted January 28, 2015 @hottehead, I did not, actually. Could it be because I used an alias (+ symbol)? Nope, looks like its an issue with sendmail on my machine. Anyways I send you a handmade mail with your credentials Gonna try to fix it this evening. And if I have time afterwards I will write a little to get this thing started. @boardman94:You registered before the activation plugin? Can you login? Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606910 Share on other sites More sharing options...
SeriousCreeper Posted January 28, 2015 Share Posted January 28, 2015 Just registered as well. Thanks for setting it up Link to comment https://forums.kleientertainment.com/forums/topic/49357-is-there-a-real-api-documentation/#findComment-606924 Share on other sites More sharing options...
Recommended Posts
Create an account or sign in to comment
You need to be a member in order to leave a comment
Create an account
Sign up for a new account in our community. It's easy!
Register a new accountSign in
Already have an account? Sign in here.
Sign In Now