# API Reference for Atom **URL:** \ **Category:** The Defoldmine\ **Created:** [January 31, 2017, 12:53pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657 "2017-01-31T12:53:08Z")\ **Posts on this page:** 20\ **Page:** 1
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [January 31, 2017, 12:53pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/1 "2017-01-31T12:53:08Z")
As I am using Atom a lot to code, thanks to the awesome @dapetcu21 defold-ide extension, I made an extension myself that helps me consult the Defold API reference docs without going back and forth with the browser. You can find the repository here [https://github.com/otapliger/defold-api](https://github.com/otapliger/defold-api) and the atom package page here [https://atom.io/packages/defold-api](https://atom.io/packages/defold-api) After installing it, you can open the pane from the menu bar or pressing `ctrl-alt-o` on the keyboard ![](https://raw.githubusercontent.com/otapliger/defold-api/master/screenshot.png) ### Plans for the future: - Add an option to change the local-server port - Add an option to make the pane use the colours of the current atom theme ---
**Author:** ![sicher](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/sicher/32/8_2.png) [@sicher](https://forum.defold.com/u/sicher)\ **Post date:** [January 31, 2017, 1:01pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/2 "2017-01-31T13:01:03Z")
Cool! If you want to pull the docs offline we have them in json format (with html doc srings) as well. DM me if you want to have a look. ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [January 31, 2017, 1:03pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/3 "2017-01-31T13:03:27Z")
they are already offline. The way it works now is creating a local-server and providing the pages through it ---
**Author:** ![sicher](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/sicher/32/8_2.png) [@sicher](https://forum.defold.com/u/sicher)\ **Post date:** [January 31, 2017, 2:50pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/4 "2017-01-31T14:50:15Z")
Nice! ---
**Author:** ![dapetcu21](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/dapetcu21/32/25120_2.png) [@dapetcu21](https://forum.defold.com/u/dapetcu21)\ **Post date:** [January 31, 2017, 2:54pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/5 "2017-01-31T14:54:58Z")
Maybe after I’m done with exams, we could find a way to integrate this into defold-ide’s “More” link 😃 ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [January 31, 2017, 3:25pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/6 "2017-01-31T15:25:59Z")
Definitely! Would be great 🙂 ---
**Author:** ![dapetcu21](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/dapetcu21/32/25120_2.png) [@dapetcu21](https://forum.defold.com/u/dapetcu21)\ **Post date:** [January 31, 2017, 3:41pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/7 "2017-01-31T15:41:44Z")
Also, no need to add option to change keyboard shortcut because every keyboard shortcut is customisable in Atom anyway. ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [January 31, 2017, 3:45pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/8 "2017-01-31T15:45:42Z")
I see… good to know 😃 ---
**Author:** ![Davej](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/davej/32/3451_2.png) [@Davej](https://forum.defold.com/u/Davej)\ **Post date:** [January 31, 2017, 5:26pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/9 "2017-01-31T17:26:21Z")
Damn, noyce work @otapliger. 👍 ---
**Author:** ![nicloay](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/nicloay/32/1895_2.png) [@nicloay](https://forum.defold.com/u/nicloay)\ **Post date:** [January 31, 2017, 9:19pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/10 "2017-01-31T21:19:34Z")
Thank you very much. Last days i had a very terrible internet connections and on macos is only one option - using Dash. but i don’t want to pay 30$ just for offline doc viewer so couple of times i just waited 10 seconds until it showed me what i need. Good luck in development! Atom is really handy tool and save a lot of time in development. And i’m happy that you and @dapetcu21 doing this great stuff. Thank you all again! ---
**Author:** ![Tomires](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/tomires/32/3885_2.png) [@Tomires](https://forum.defold.com/u/Tomires)\ **Post date:** [February 6, 2017, 9:11pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/11 "2017-02-06T21:11:58Z")
Try Zeal, it’s pretty much the same thing as Dash, except it’s free and multi-platform. > **[Zeal - Offline Documentation Browser](https://zealdocs.org/)** Although if Atom is your editor of choice it’s a little bit pointless to have another app open. 🙂 ---
**Author:** ![nicloay](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/nicloay/32/1895_2.png) [@nicloay](https://forum.defold.com/u/nicloay)\ **Post date:** [February 6, 2017, 9:42pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/12 "2017-02-06T21:42:37Z")
I know about zeal. but i think it require some magic with xquarts as it not [showed at download page](https://zealdocs.org/download.html). And even if it will work i don’t like not native application because of different hot keys and ui. ---
**Author:** ![Tomires](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/tomires/32/3885_2.png) [@Tomires](https://forum.defold.com/u/Tomires)\ **Post date:** [February 11, 2017, 10:00am UTC](https://forum.defold.com/t/api-reference-for-atom/4657/13 "2017-02-11T10:00:43Z")
Sorry, didn’t realise they don’t do macOS natively ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [February 28, 2017, 10:44pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/14 "2017-02-28T22:44:48Z")
Updated to the API reference last version (1.2.98) ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [July 13, 2017, 7:05pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/15 "2017-07-13T19:05:00Z")
I finally had the time to update the package to the last version of Defold (1.2.108) 🙂 Thanks to @britzl as I am using his python script to download and automatically create the docs. It is much easier to keep it up to date! ---
**Author:** ![andreas.strangequest](https://forum-defold.b-cdn.net/user_avatar/forum.defold.com/andreas.strangequest/32/3622_2.png) [@andreas.strangequest](https://forum.defold.com/u/andreas.strangequest)\ **Post date:** [July 14, 2017, 7:45am UTC](https://forum.defold.com/t/api-reference-for-atom/4657/16 "2017-07-14T07:45:34Z")
Hmm, unfortunately I cant get it to work. Short cut on OSX doesnt seem to work and when looking in Menu/Packages/Defold\_API there is only one About button that doesnt work. Tried rebind shortcut to cmd but nothing… ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [July 14, 2017, 7:50pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/17 "2017-07-14T19:50:54Z")
I see… I had the same problem as soon after I published the package. I shut down windows, reopened Atom and an info box appeared suggesting me to rebuild the package. I clicked rebuild and it worked. I thought it was just me but it seems I was wrong 🙂 let me investigate more on this and I will hopefully publish a working version today. Thanks for the feedback 😉 ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [July 14, 2017, 7:51pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/18 "2017-07-14T19:51:56Z")
BTW, the About button is just a placeholder for now and does nothing ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [July 14, 2017, 8:58pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/19 "2017-07-14T20:58:49Z")
Ok, I am not sure if I fixed it or not as I couldn’t replicate the problem again, but I published a new version which I think will solve it. If you want to try to download, please let me know if you still have the problem. In that case, the quickest solution I can give you now is going to the package directory (.atom\packages\defold-api inside your user folder) and running in the terminal “apm rebuild” without quotes ---
**Author:** ![anon22845022](https://forum-defold.b-cdn.net/letter_avatar_proxy/v4/letter/a/8c91f0/32.png) [@anon22845022](https://forum.defold.com/u/anon22845022)\ **Post date:** [March 10, 2018, 3:16pm UTC](https://forum.defold.com/t/api-reference-for-atom/4657/20 "2018-03-10T15:16:29Z")
Updated the API reference to the last version (1.2.122) and the Atom package version from now on corresponds to the Defold API reference version it is using. So Defold-API 1.2.122 means it us using Defold 1.2.122 as API now, as I don’t update often, do you people still use this extension? do you think it is useful? also, when I update, do you prefer that I dont post it here so it not bumps up in the forum? [Next page](https://forum.defold.com/t/api-reference-for-atom/4657.md?page=2)