Skip to content

Commit

Permalink
Turn Atom into Pulsar
Browse files Browse the repository at this point in the history
Renamed all strings
Updated readme and FAQ
changed default Discord AppId
  • Loading branch information
mzivic7 committed Nov 11, 2024
1 parent 5eef757 commit b9c9db6
Show file tree
Hide file tree
Showing 30 changed files with 186 additions and 356 deletions.
124 changes: 30 additions & 94 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -1,125 +1,61 @@
[![Discord](https://s33.postimg.cc/savzs5uhb/atom-banner.png)](http://discord.gg/zfEs3K6)

<p align="center">
<b><a href="https://github.com/HelloWorld017/atom-discord">Atom-Discord</a></b> / <a href="https://github.com/HelloWorld017/atom-discord/blob/master/faq.md">FAQ</a>
<b><a href="https://github.com/mzivic7/pulsar-discord">Pulsar-Discord</a></b> / <a href="https://github.com/mzivic7/pulsar-discord/blob/main/faq.md">FAQ</a>
</p>

---

# FAQ

* [Custom Playing Status](#playing-status)
* [Getting File Icons](#getting-file-icons)

---

# Known Errors

* [There is no `apm` or `npm` command](#apm-npm-is-not-recognized)
* [Doesn't show rich pressence](#not-showing)

- [Custom Playing Status](#playing-status)
- [Rich Presence Is Not Showing](#rich-presence-is-not-showing)
- [Getting debug info](#getting-debug-info)

----

# Playing Status
## Changable Text
## Changeable Text
To change other texts like 'Editing a (name) file', follow this steps:

1. **Open i18n file**
Open file located in `(UserDirectory)/.atom/packages/atom-discord/i18n/(Currently Using Language).json`
Open file located in `(UserDirectory)/.pulsar/packages/pulsar-discord/i18n/(Currently Using Language).json`

2. **Change desired text**
Change content of the json file in order to change your desired text.

## "Playing Atom Editor" Text
To change the "Playing Atom Editor" text you will need to make a new [discord developer application](https://discordapp.com/developers/applications/me/create), you can do this by repeating the following steps:

## "Playing Pulsar Editor" Text
To change the "Playing Pulsar Editor" text you will need to make a new [discord developer application](https://discordapp.com/developers/applications/), you can do this by repeating the following steps:

1. **Create a new discord developer application.**
Click [Here](https://discordapp.com/developers/applications/me) and create a new application.
1. **Create a new discord developer application**
Click [Here](https://discordapp.com/developers/applications/) and create a new application.

2. **Set your app name and turn on rich presence.**
![Set App Name](https://i.imgur.com/2iSR7Q3.png)
![Turn on Rich Presence](https://i.imgur.com/GydIB7q.png)
> Make sure to click `Create App` first or you won't see the `Enable Rich Presence` button!
2. **Set your app name and turn on rich presence**
Your app name will later be displayed as `Playing <app-name>`.

3. **Set Client ID to your application.**
Copy your `Client ID` (found here)
![Copy](https://i.imgur.com/vVw7XjC.png)
3. **Set Client ID to your application**
Copy your `Application ID`.
And in pulsar-discord package settings change `Settings > Behaviour > Custom Client ID` into your Application ID.

And change `Settings > Behaviour > Custom Client ID` into your Client ID.
4. **Upload icons assets**
Download all of the programming languages icons ([available here](https://github.com/HelloWorld017/fileicons-render/tree/main/icons)) and upload them all under Rich Presence > Rich Presence Assets (if you miss one it won't work!). The asset name should be filename of the image (without the `.png`!).

> Now your playing status will have changed, but the icon's wont work unless you do the following.
4. **Upload large assets.**
Download all of the programming languages icons ([available here](https://github.com/HelloWorld017/fileicons-render/tree/master/icons)) and upload them all as large assets (if you miss one it won't work!). The asset name should be filename of the image (without the `.png`!) and the size should be on Large or it wont work!
Example:
![Uploading](https://i.imgur.com/Jqw3Jqu.png)

5. **Upload small assets.**
Now you can upload the small assets, you can choose not to do this however it is up to you!
If you choose to upload them you will need to upload a small asset for all 5 types of the logo.

![SmallAsset](https://i.imgur.com/iOToNbC.png)

Names:
* atom-original
* atom
* atom-2
* atom-3
* atom-5

> :tada: There, your done! Now you have a custom playing status, congratulations!
5. **Upload custom image assets**
Now, under same assets, upload the custom image that will replace original Pulsar icon. Imust have asset name `pulsar`.

---

# Getting File Icons
* You can get images from [fileicons-render](https://github.com/HelloWorld017/fileicons-render)
# Rich Presence is not showing
- Check if the Pulsar is added in the games tab.
- Check if the option `Display currently running game as a status message.` is turned on in Discord.
- Restart the Pulsar and Discord.
- Try installing from the source code:

---
Open the terminal and type the following: `pulsar -p uninstall pulsar-discord`

# apm, npm is not recognized
If you recieve the following error when installing atom-discord do the following:
```
'apm (or npm)' is not recognized as an internal or external command,
operable program or batch file.
```

Find your Atom Install Directory usually located at (`%appdata%/../Local/atom/YOUR-VERSION/resources/app/apm/bin/apm.cmd`).and instead of running the apm command, link the full directory instead!

Example:
```
C:\Users\USERNAME\AppData\Local\atom\app-1.28.0\resources\app\apm\bin\apm.cmd install atom-discord
C:\Users\USERNAME\AppData\Local\atom\app-1.28.0\resources\app\apm\bin\npm.cmd install
```

You can execute the command by changing 'apm' to whole path of apm.cmd, 'npm' to path of npm.cmd
Then, [reinstall pulsar-discord from the source code](https://github.com/mzivic7/pulsar-discord#installing-from-source-code) and restart Pulsar and discord.

---

# Not Showing
If you rich presence isn't showing in discord, make sure you have got Atom-Editor added as a program, and if that doesnt work try [installing from the source code](https://github.com/HelloWorld017/atom-discord#installing-from-source-code), and if that doesn't work, try the following:

Open the terminal by using `Ctrl + R` and type the following:

```
apm uninstall atom-discord
```

Then, [reinstall atom-discord from the source code](https://github.com/HelloWorld017/atom-discord#installing-from-source-code)


And, if _that_ doesn't work, you can try quitting Atom via Task Manager or <kbd>cmd</kbd> + <kbd>q</kbd>

## Notes for Ubuntu users
There are a known bug that discord **installed from snap / software center** doesn't show rich presence.

If you're using ubuntu, installed discord from snap and rich presence isn't showing, please check you've turned on the `Ubuntu 18.04 fix` option.
After turning the option and restarting atom, and if the problem still exists, please follow these steps.

* `sudo snap remove vscode discord`
* download the .deb files from the official websites
* install the .deb files using the `sudo dpkg -i package.dpkg` command
* DO NOT USE UBUNTU SOFTWARE CENTER, AS IT USES SNAP.

If you're still running into trouble, please ask for help in our [support server](https://discordapp.com/invite/zfEs3K6)!
# Getting debug info
- Turn on Debug Mode option in package settings
- Restart Pulsar
- Open file `(UserDirectory)/.pulsar/pulsar-discord/Log.txt
31 changes: 8 additions & 23 deletions ICONS.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,19 @@
## License of icons

### Atom Alternative Icon 2
* Source: [Wikimedia(Fabián Alexis)](https://commons.wikimedia.org/wiki/File:Antu_atom-text-editor.svg)
* License: Creative Commons Attribution-Share Alike 3.0 Unported license
### Pulsar icon
* Source: [pulsar-edit/pulsar](https://github.com/pulsar-edit/pulsar)
* License: MIT License

### Atom Alternative Icon 3
* Source: [edwardloveall/atom-replacement-icon](https://github.com/edwardloveall/atom-replacement-icon)
* License: The MIT License
MIT License

The MIT License (MIT)
Copyright (c) 2022-2024 Pulsar-Edit Original work copyright (c) 2011-2022 GitHub Inc.

Copyright (c) [year] edwardloveall
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

### File icons
* Source: [file-icons/atom](https://github.com/file-icons/atom)
Expand Down
4 changes: 2 additions & 2 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@

## Information
**Platform**: [Platform (OS)]
**Atom**: [Atom Version]
**Package Version**: [Commit Hash or Tag(Version)]
**Pulsar**: [Pulsar Version]
**Package Version**: [Commit Hash or Tag(Version)]

### Non-Core Packages
```
Expand Down
3 changes: 2 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
MIT License

Copyright (c) 2017 Khinenw
Copyright (c) 2018 HelloWorld017
Copyright (c) 2024 mzivic7

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
84 changes: 14 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,104 +1,48 @@
[![Discord](https://s33.postimg.cc/savzs5uhb/atom-banner.png)](http://discord.gg/zfEs3K6)

<p align="center">
<b>Atom-Discord</b><br>
<a href="https://discord.gg/zfEs3K6">Support</a> |
<a href="https://atom.io/packages/atom-discord">Atom</a> |
<a href="https://github.com/HelloWorld017/atom-discord/blob/master/FAQ.md">FAQ</a>
<b>Pulsar-Discord</b><br>
<a href="https://web.pulsar-edit.dev/packages/pulsar-discord">Pulsar</a> |
<a href="https://github.com/mzivic7/pulsar-discord/blob/main/FAQ.md">FAQ</a>
<br><br>
</p>

<p align="center">
<a href="https://david-dm.org/HelloWorld017/atom-discord">
<img src="https://img.shields.io/david/HelloWorld017/atom-discord.svg?style=flat-square" alt="David">
</a>

<a href="https://github.com/HelloWorld017/atom-discord/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/HelloWorld017/atom-discord.svg?style=flat-square" alt="License">
</a>

<a href="https://atom.io/packages/atom-discord">
<img src="https://img.shields.io/apm/v/atom-discord.svg?style=flat-square" alt="Apm Version">
</a>

<a href="https://atom.io/packages/atom-discord">
<img src="https://img.shields.io/apm/dm/atom-discord.svg?style=flat-square" alt="Apm Version">
</a>

<a href="https://discord.gg/zfEs3K6">
<img src="https://img.shields.io/discord/405937562813726730.svg?logo=discord&style=flat-square&label=Discord&colorA=7289da&colorB=606060" alt="Discord">
</a>
</p>

----

# Installation

To install atom-discord you will need to download the following dependencies:

- Git

Download the [latest](https://git-scm.com/download) version of git.


## Installing from Atom Package Manager
Then either download the package via the built in package repo (Atom Settings > Install > atom-discord) or run `apm install atom-discord` in your terminal of choice.

## Installing from Pulsar Package Manager
Either download the package via the built in package manager (Pulsar Settings > Install > pulsar-discord) or run `pulsar -p install pulsar-discord` in your terminal of choice.

## Installing from Source Code

It is fairly easy to install from the source code, here's how to do it!
To install pulsar-discord you will need to download the [latest](https://git-scm.com/download) version of git.

Navigate to a empty folder then click `Git Bash Here`, then enter the following into the terminal:
Then open terminal and navigate to an empty folder, then enter the following into the terminal:

```
git clone https://github.com/HelloWorld017/atom-discord.git
cd atom-discord
git clone https://github.com/mzivic7/pulsar-discord.git
cd pulsar-discord
npm i
apm link
pulsar -p link
```

Then **add atom to discord game list** and restart atom to see the effects.

:tada: You installed atom-discord.
Then **add pulsar to discord game list** and restart pulsar to see the effects.

----

# Checklist when Rich Presence is not showing

* Check if the Atom is added in the games tab.
* Check if the option `Display currently running game as a status message.` is turned on.
![Imgur](https://i.imgur.com/OjFerWL.png)
* Check if you restarted the Atom. (If not works, please restart discord, too.)
* Please follow the [steps from FAQ](https://github.com/HelloWorld017/atom-discord/blob/master/FAQ.md#not-showing).
* Check if there are some outputs in developer tools `(ctrl + shift + i)`.

If you checked all of them but you couldn't find the reason why, please come to discord and send your symptom with your operating system and `~/.atom/atom-discord/log.txt`

# FAQ

# FAQ / Know Errors

[Please visit here to see all the known errors / questions](https://github.com/HelloWorld017/atom-discord/blob/master/FAQ.md)


# Todos

- Icon Chooser, Custom Icons
- Rich Presence Text Editor
- Teletype Integration
[Please go here to see troubleshooting and questions](https://github.com/mzivic7/pulsar-discord/blob/main/FAQ.md)

---

# Screenshots
![Discord Integration](https://i.imgur.com/EMd4eZg.png)

# License

Released under the [MIT](https://en.wikipedia.org/wiki/MIT_License) License.

>MIT License
>
>Copyright (c) 2018 HelloWorld017
>Copyright (c) 2024 mzivic7
>
>Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion examples/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8">
<title>Atom Discord UI Test</title>
<title>Pulsar Discord UI Test</title>
<link rel="stylesheet" href="/dist/example.bundle.less">
</head>

Expand Down
2 changes: 1 addition & 1 deletion i18n/cs-CZ.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"working-no-project": "Pracuje na projektu",
"editing-file": "Edituje %fileName%",
"editing-idle": "Odpočívá",
"atom-description": "Pracuje v Atomu",
"pulsar-description": "Pracuje v Pulsar",
"type-description": "Edituje %type% soubor",
"type-unknown": "Edituje soubor",
"developer-idle": "Tento vývojář dokonce dokáže i ODPOČÍVAT!"
Expand Down
2 changes: 1 addition & 1 deletion i18n/de-DE.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"working-no-project": "Arbeitet an Kram",
"editing-file": "Bearbeitet %fileName%",
"editing-idle": "Abwesend",
"atom-description": "Arbeitet mit Atom",
"pulsar-description": "Arbeitet mit Pulsar",
"type-description": "Bearbeitet eine %type% Datei",
"type-unknown": "Bearbeitet eine Datei",
"developer-idle": "Der Entwickler ist überarbeitet genug um sich auszuruhen!"
Expand Down
Loading

0 comments on commit b9c9db6

Please sign in to comment.