Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 4.23 KB

README.md

File metadata and controls

91 lines (58 loc) · 4.23 KB
Raw

RVMob

RVMob is a Revolt client made with React Native. It is currently available for Android and will be available for web in the future.

Please note that RVMob is currently in beta. It contains several bugs and incomplete features - use at your own discretion.

For development updates and other news, join RVMob's support server.

Installing

If you want to install RVMob for Android, simply go to the releases tab and download the latest version. We plan on publishing RVMob to app stores in the future.

Debug builds are also produced for every commit. These are unoptimised - they're much larger and noticeably slower than the release builds, but you can try out new features early.

Info about split builds

Also note that, from v0.7.0, RVMob's APKs are split by architecture. This helps to reduce file and app sizes - however, you'll need to make sure that you download the APK that matches your device's architecture, or it won't install!

If you're using an app store, this should be handled for you.

If not, however, you'll need to check your device's architecture. I'd recommend using Treble Info for this.

Install and open the app - don't worry about what it says on the home page! - then open the Details tab and check the CPU architecture entry. Depending on what it says:

  • if it says ARM64, you'll want the APK with arm64-v8a in its file name;
  • if it says ARM32, you'll want the APK with armeabi-v7a in its file name;
  • if it says x86_64, you'll want the APK with x86_64 in its file name;
  • and if it says x86, you'll want the APK with x86 but without 64 in its file name.

If it says Unknown, please ask for help in our support server.

Building

If you want to build RVMob for web, you'll need:

If you want to build RVMob for Android, you'll also need:

Then run the following:

yarn install
npx react-native-asset

# for web:
yarn web

# for android, run the following then press `a`:
yarn start

CLI commands:

Command Description
yarn start Starts Metro (the dev server).
yarn test Tests to see if everything is working.
yarn web Runs the web app.
yarn android Runs the Android app.
yarn ios Runs the iOS app (broken/requires a Mac).
yarn lint Checks the code syntax using ESLint.

For more information, see a list of react-native's commands here. You can access them by running yarn react-native.

Troubleshooting

If you encounter bugs, first check if you're able to open Revolt in your browser; also, check if you have any firewall settings that may block the Revolt API.

If you're still experiencing issues, and there aren't any open issues for the bug(s) you're facing, please open an issue.

License

RVMob is licensed under the GNU Affero General Public License v3.0.