Skip to content

Commit

Permalink
tidy: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@stowmyy
stowmyy committed Nov 1, 2024
1 parent f94f804 commit 883fc90
Showing 1 changed file with 17 additions and 78 deletions.
95 changes: 17 additions & 78 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,6 @@ OW2 // DROPSHIP
<td>
<img src="https://github.com/stowmyy/dropship/assets/120167078/55ba7db6-7d37-4eec-b50f-e1e52192009f" />
</td>
<!-- <td>
download <a href="https://github.com/stowmyy/dropship/releases/latest/download/dropship.exe" target="_blank"><code>dropship.exe</code></a>
</td> -->
<td>
a portable OW2 server selector
</td>
Expand All @@ -30,131 +27,73 @@ OW2 // DROPSHIP
<pre>versions</pre>
</a>
</td>
<!-- <td>
<ul>
<li>not affiliated with blizzard</li>
<li>twitter: <a href="https://twitter.com/stormyy_ow/" target="_blank">@stormyy_ow</li>
</ul>
</td> -->
</tr>
</table>

<!--
> [!NOTE]
> - not affiliated with blizzard
> - twitter: [@stormyy_ow](https://twitter.com/stormyy_ow/)
-->

## notes

<!--
- this app lets you choose which OW2 servers to play on
- this app is a tiny `.exe` file and doesn't install anything extra
- this app updates automatically when you open it
- this app is open source and the `.exe` is automatically generated [here](https://github.com/stowmyy/dropship/actions)
- not affiliated with blizzard
- twitter: [@stormyy_ow](https://twitter.com/stormyy_ow/)
-->
- not affiliated with blizzard
- twitter: [@stormyy_ow](https://twitter.com/stormyy_ow/)

## how to use
<ol>

<li>download and open this app <small>after reading the warnings below</small></li>
<li>deselect regions to <strong>permanently block</strong> them, they will stay blocked until you select them again</li>
<li>done :]</li>


</ol>

<!--
```yml
1: open app
2: find app in your taskbar (bottom of your monitor) and right click > pin to taskbar
```
-->


<!--
<ul>
<li>
pinning this app to your taskbar for quick access is a good idea
</li>
</ul>
-->

<!--
1. download and open the app after reading the warnings below
2. deselect the servers you wish to block
3. deselecting servers will block them **permanently** until you allow them again
4. pinning this app to your taskbar is reccomended for quick access
-->
| type | description |
| -- | -- |
| ![image](https://github.com/user-attachments/assets/d8449dd3-0492-4d90-833b-b3bfa8c874b5) | **allow** - all servers are allowed by default, OW2 may connect to them |
| ![image](https://github.com/user-attachments/assets/269b9d27-8b18-4bfb-a2fd-350559f4116a) | **block** - OW2 will not connect to blocked servers |
| ![image](https://github.com/user-attachments/assets/f3612723-76b8-4211-8192-13209bf476c2) | **gonna block** - servers can't be blocked while you are playing the game. please restart your game with the app open |

> [!IMPORTANT]
> <h2>disconnect warnings</h2><ol><li><strong>do not queue with other people</strong> unless they have the same servers blocked as you do</li><li>keep in mind this app will also affect <strong>unranked</strong> and <strong>custom games</strong></li></ol>
> <h2>disconnect warnings</h2><ol><li><strong>do not queue with other people</strong> unless they have the same servers blocked as you do</li><li>keep in mind this app may also affect <strong>unranked</strong> and <strong>custom games</strong></li><li>If you are ever failing to connect to a server, quickly clicking this button will prevent a competitive ban<br /> <img src="https://github.com/user-attachments/assets/032869b8-2915-4b41-96b9-cdb7d2423ff0"/></li></ol>
<!--
## disconnect warnings
1. **do not queue with other people** unless they have the same servers blocked as you do
2. keep in mind this app does also affect **unranked** and **custom games**
-->


> [!IMPORTANT]
> <h2>if you are having trouble connecting</h2><ul><li><i>quickly</i> open this app and unblock servers or you may time out and disconnect<ul><li>this should never happen if you follow the warnings but please keep it in mind or you may get disconnected and recieve a temporary competitive ban</li></ul></li><li>blocking OW2 servers can unintentionally affect other games, a fix is being worked on and will be available in a future update</li></ul>

<!--
## if you are having trouble connecting
- _quickly_ open this app and unblock servers or you may time out and disconnect
- this _should_ never happen if you follow the warnings but please keep it in mind or you may get disconnected and recieve a temporary competitive ban
- blocking OW2 servers can unintentionally affect other games. a fix is being worked on and will be available in a future update
-->

## FAQ

<!--
> [!TIP]
> it's a good idea to pin this app to your taskbar for quick access
-->

question | answer
:-------------------------|:-------------------------
do i need to keep the app open? | no, deselecting servers will block them permanently until you select them again
what does a grayed out server mean? | the app could not ping the server, you can still block it
how do i uninstall? | allow all servers and then delete the `.exe` - a proper `uninstall` button is being worked on
how do i uninstall? | click the `unblock` button and then delete the `.exe`
does this app install anything? | this app is a portable `.exe` file and does not install anything
how do i update this app? | this app updates automatically when you open it
why does the app not open? | it should - please let me know on twitter and i can try to fix it for you
how do i update this app? | an update button should appear when an update is available
does this app have a virus? | no, all the source code is above and `dropship.exe` is generated [here](https://github.com/stowmyy/dropship/actions)
does this app support `tunneling`? | yes, `tunneling` is enabled by default and configurable in `options`
what is `tunneling`? | `tunneling` makes sure servers are blocked per-application instead of globally. `tunneling` prevents servers in other games and apps from becoming unintentionally blocked
how do i pin this app to my taskbar? | <img src="https://github.com/user-attachments/assets/a0cf3cf5-4b24-4ee5-b893-b95a73b9e75b" height="90" />
does this app modify the game? | this app does **_not_** modify the game in any way. instead, this app works by adding windows firewall rules that block certain servers just like an ad blocker would

<!-- - if you ever get disconnected this means the OW2 servers were changed and i need to update the app - please let me know through [discord](https://discord.stormy.gg/) or [twitter](https://twitter.stormy.gg/) so i can fix it -->

## technical support
- if you ever get disconnected this means the OW2 servers were changed and i need to update the app - please let me know through [discord](https://discord.stormy.gg/) or [twitter](https://twitter.stormy.gg/) so i can fix it
- if this app does not work for you, please reach out
- if you ever get disconnected or the app does not work, please contact me via [discord](https://discord.stormy.gg/) and [twitter](https://twitter.stormy.gg/) so i can fix it
- if a critical feature is missing, please suggest it in the [discord](https://discord.stormy.gg/)

<!--
<hr />
-->

## media

<!--
with game closed | with game open | settings
:--:|:--:|:--:
<img src="https://github.com/user-attachments/assets/b560e3b4-4bf1-4668-a56b-c7adc145a121" height="400"/> | <img src="https://github.com/user-attachments/assets/01a6fe0b-aa73-4560-8b80-5eb527fabe02" height="400" /> | <img src="https://github.com/user-attachments/assets/5555e056-3a57-463c-802b-558b81e66563" height="400" />
-->


app | options | socials
:--:|:--:|:--:
<img src="https://github.com/user-attachments/assets/ec9f7241-0205-495c-b8b6-5f31dc2e9796" height="400"/> | <img src="https://github.com/user-attachments/assets/890bc3b7-878a-4a9e-8a61-7bc1bf528d53" height="400" /> | <img src="https://github.com/user-attachments/assets/0d65436c-cea6-4687-9a07-fc0d9dd8f321" height="400" />


## acknowledgements
- [foryVERX/Overwatch-Server-Selector](https://github.com/foryVERX/Overwatch-Server-Selector/)
- this app is very similar with a larger community around it
- dropship shares the same server ips as this app
- dropship should be seen as a simplified, lightweight, and portable alternative
- despite no longer being supported by the developer, this is a very similar app with a large community
- dropship is a simplified, maintained, and portable alternative

0 comments on commit 883fc90

Please sign in to comment.