{"id":25284575,"url":"https://github.com/dinographicpixels/touchguild-docs","last_synced_at":"2025-04-06T14:48:21.871Z","repository":{"id":58789479,"uuid":"529358709","full_name":"DinographicPixels/touchguild-docs","owner":"DinographicPixels","description":"TouchGuild documentation and guide.","archived":false,"fork":false,"pushed_at":"2022-11-20T12:07:56.000Z","size":7966,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-12T20:51:56.161Z","etag":null,"topics":["docs","javascript","nodejs","npm","touchguild"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DinographicPixels.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-26T18:02:22.000Z","updated_at":"2023-01-26T20:22:25.000Z","dependencies_parsed_at":"2023-01-22T17:46:33.284Z","dependency_job_id":null,"html_url":"https://github.com/DinographicPixels/touchguild-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DinographicPixels%2Ftouchguild-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DinographicPixels%2Ftouchguild-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DinographicPixels%2Ftouchguild-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DinographicPixels%2Ftouchguild-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DinographicPixels","download_url":"https://codeload.github.com/DinographicPixels/touchguild-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247500452,"owners_count":20948878,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","javascript","nodejs","npm","touchguild"],"created_at":"2025-02-12T20:51:58.617Z","updated_at":"2025-04-06T14:48:21.851Z","avatar_url":"https://github.com/DinographicPixels.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ndescription: TouchGuild is a NodeJS library for interfacing with Guilded.\n---\n\n# 🌟 Get started\n\n\u003cfigure\u003e\u003cimg src=\".gitbook/assets/touchguild-cradius.png\" alt=\"\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\n\n## Installation\n\nNodeJS **16.16.0** or higher is required.\n\n{% tabs %}\n{% tab title=\"npm\" %}\n```bash\nnpm install touchguild@latest\n```\n{% endtab %}\n\n{% tab title=\"yarn\" %}\n```bash\nyarn add touchguild@latest\n```\n{% endtab %}\n\n{% tab title=\"ppm\" %}\n```bash\npnpm add touchguild@latest\n```\n{% endtab %}\n{% endtabs %}\n\n## Get started\n\n```javascript\nconst TouchGuild = require('touchguild'); // import for CommonJS\n// import * as TouchGuild from 'touchguild' // import for ESM \u0026 TS\n\nconst client = new TouchGuild.Client({token: 'insert token here'});\n\nclient.on('ready', ()=\u003e {\n   console.log(`Logged as ${client.user.username}`);\n});\n\nclient.on('error', (err)=\u003e {\n   console.error(\"Whoops, somethin' went wrong..\", err);\n});\n\nclient.connect();\n```\n\n{% hint style=\"info\" %}\nNote: CommonJS, ESM \u0026 Typescript are supported.\n{% endhint %}\n\n## Development builds (Nightly)\n\nNightly builds are pre-release builds, they're having new features in real time. Once there's enough features, we're releasing them as a brand new 'stable build'.\n\n\u003cfigure\u003e\u003cimg src=\".gitbook/assets/touchguild nightly.png\" alt=\"\"\u003e\u003cfigcaption\u003e\u003c/figcaption\u003e\u003c/figure\u003e\n\n## Install Nightly builds\n\nYou can get new features before the stable release.\n\n### Install the latest Nightly build automatically:\n\n{% tabs %}\n{% tab title=\"npm\" %}\n```bash\nnpm install touchguild@nightly\n```\n{% endtab %}\n\n{% tab title=\"yarn\" %}\n```bash\nyarn add touchguild@nightly\n```\n{% endtab %}\n\n{% tab title=\"ppm\" %}\n```bash\npnpm add touchguild@nightly\n```\n{% endtab %}\n{% endtabs %}\n\n### Install the latest Nightly build manually:\n\n```bash\nnpm install dinographicpixels/touchguild#nightly\n```\n\n1. Run the command\n2. Go to `node_modules/touchguild`\n3. Run: `npm run build` inside the touchguild folder\n4. \u0026#x20;Now, it's ready.\n\nYou need to reproduce those steps everytime you update to a newer nightly build.\n\n{% hint style=\"warning\" %}\nBe aware that Nightly builds aren't stable and can have still have major bugs. If you face issues, feel free to report it by creating an issue on TouchGuild's GitHub, please specify that you're using a Nightly build.\n{% endhint %}\n\n{% hint style=\"info\" %}\nYou can check [Nightly Features here.](broken-reference)\n{% endhint %}\n\n## Additional links:\n\n#### Repository \u0026 NPM\n\n* [NPM Package](https://www.npmjs.com/package/touchguild)\n* [GitHub](https://github.com/DinographicPixels/TouchGuild)\n\n#### Guide \u0026 documentation\n\n* [Guide](https://guide.touchguild.dinographicpixels.com)\n* [Documentation](documentation/select-version/)\n\n#### Additional links\n\n* [Our vision of the project](https://docs.touchguild.dinographicpixels.com/misc/our-vision)\n* [FAQ](https://docs.touchguild.dinographicpixels.com/misc/faq)\n* [Get started, youtube video](https://www.youtube.com/watch?v=AUaiQRMjJZo)\n\n#### Our servers\n\n* [Our Discord server](https://discord.gg/UgPRaGRkrQ)\n* [Our Guilded server](https://www.guilded.gg/i/ExPXPrwE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdinographicpixels%2Ftouchguild-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdinographicpixels%2Ftouchguild-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdinographicpixels%2Ftouchguild-docs/lists"}