Improved README and added banner image.

This commit is contained in:
Rob Atkinson committed 2020-07-14 19:10:37 +08:00
1 parent 6ebfd8cbc4
commit c860d83a53
2 files changed
+26 -45

No files matched your search

+24 -43
View File
@@ -1,24 +1,17 @@
# sudomemoDNS
This server will allow you to connect to Sudomemo when
your Internet Service Provider does not work with custom DNS.
![sudomemoDNS Logo](/sudomemoDNS_banner.png)
## This server will allow you to connect to Sudomemo when your Internet Service Provider does not work with custom DNS.
## Setup
The setup process does not differ from what is shown at
https://support.sudomemo.net/setup except for the values
to enter in your custom DNS settings.
The setup process does not differ from what is shown at https://flipnot.es/setup except for the values to enter in your custom DNS settings.
First, make sure that your console is connected to the same network as this computer.
Please submit any issues to Sudomemo Support.
First, make sure that your Nintendo DSi is connected to the
same network as this computer.
This is the initial release of sudomemoDNS. Please submit any issues to Sudomemo Support.
# Running on Windows:
## Running on Windows:
Run the .exe provided in this release. You may have to click past a warning from Windows SmartScreen (as it sometimes turns its nose up at applications bundled by PyInstaller) or your firewall (as it needs to listen for DNS requests).
# Running on anything else:
## Running on anything else:
Required packages (installable with pip): requests, dnslib
Required Python version: 3+, tested with 3.6
@@ -31,44 +24,32 @@ The following will display when you start it up:
+===============================+
| Sudomemo DNS Server |
| Version 1.0 |
| Version 1.1 |
+===============================+
Hello! This server will allow you to connect to Sudomemo when
your Internet Service Provider does not work with custom DNS.
#### How To Use ####
The setup process does not differ from what is shown at
https://support.sudomemo.net/setup except for the values
to enter in your custom DNS settings.
First, make sure that your Nintendo DSi is connected to the
same network as this computer.
Here are the settings you will put in for DNS on your Nintendo DSi:
Primary DNS: XX.XX.XX.XX (NOTE: this value will be unique when you run the program)
== Welcome to SudomemoDNS! ==
This server will allow you to connect to Sudomemo when your Internet Service Provider does not work with custom DNS.
== How To Use ==
First, make sure that your console is connected to the same network as this computer.
Then, put these settings for DNS on your console:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Primary DNS: XXX.XXX.XXX.XXX (NOTE: This value will be unique when you run the program)
Secondary DNS: 8.8.8.8
All other settings should match what is shown at the above URL.
#### Getting Help ####
Need help? Visit our Discord server or check out https://support.sudomemo.net.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
== Getting Help ==
Need help? Visit our Discord server or check out https://support.sudomemo.net
When entering your DNS settings, if the Primary DNS is displayed like this (this is an example):
192.168.1.7
then you can enter it as follows:
192.168.001.007
## Building on Windows
# Building on Windows
Install dnslib and requests via pip (as well as pyinstaller) and then build with pyinstaller:
C:\Users\Administrator\sudomemo-dns>C:\Users\Administrator\AppData\Local\Programs\Python\Python36\Scripts\pyinstaller.exe sud
omemoDNS_v1.0.spec
Install dnslib, requests, and pyinstaller via pip, then modify the paths in the spec file to where sudomemoDNS and the sudomemoDNS icon is stored.
Then, run the following as an administrator:
pyinstaller.exe sudomemoDNS_v1.1.spec