Something Awful Forums browser for iOS
Awful is an iOS 9.0+ app that's Better Than Safari for browsing the Something Awful Forums. Its story is told in its thread (and the thread before that (and the thread before that (and the thread before that))).
Not sure what to work on? There's a list of issues, or just post in the thread and someone will share their pet peeves for your amusement!
This app is not endorsed by Something Awful.
You need Xcode 11 or 12 to build and run Awful. You can download Xcode for free from Apple. Then:
git clone --recursive https://github.com/Awful/Awful.app Awful-app
You may see build warnings of the form "Unable to find included file '../Local.xcconfig'". You should still be able to build and run, just with a couple of features turned off. If you'd like to enable those features, or just make the warnings go away, please scroll on down to the "Local build settings" section below.
The only required dependencies for building Awful that are not included directly in this repository are those managed by Swift Package Manager. Files generated by other utilities are included in the repository. The only submodule is the thread-tags repository, which is not strictly needed for building; if you don't need it, you can leave off the
--recursivepart from step one.
If you'd like to build to your device, set the
DEVELOPMENT_TEAMbuild setting as mentioned in the Local build settings section below.
There are optional dependencies for building Awful. You only need them if you're working on the relevant part of the app.
Gemfilenearby if you want to use a known working version of CocoaPods.
App/Templates/Acknowledgements.html.stencilwith the name and license of the dependency. We do not use CocoaPods-generated acknowledgements.
posts-view*.less), please install LESS:
brew install node.
npm install less -g.
There are some local build settings that can be useful to include but should not be committed to a public repo. Store those in an Xcode configuration file at
Local.xcconfig; see Local.sample.xcconfig for an example. You'll get a build warning until you put a file at that location; it can be an empty file if you just want Xcode to be quiet.
Awful uses an App Group to communicate and share data with the Smilie Keyboard. Unfortunately, App Group identifiers must be unique, so we can't simply set it up in this repository and have it work for everybody work. By default, Awful builds without an App Group configured, which means that the Smilie Keyboard won't be able to download new smilies, remember recent smilies, or store favourite smilies. If you like, you can:
CODE_SIGN_ENTITLEMENTSbuild setting in
Local.xcconfigfor the targets
Local.sample.xcconfigfor a suggested setup).
There are unit tests, that don't cover much, running continuously via GitHub Actions.
Dependencies not managed via CocoaPods or Swift Package Manager are placed in the Vendor folder and manually kept up-to-date. They include:
UIActivitysubclasses but continue to use the libraries' images.
Bump the major version when changing the minimum required iOS version (deployment target). Otherwise, bump the minor version.
Also, when changing the iOS deployment target, please tag the last commit that supports any no-longer-supported deployment target(s) and update the table in the section "iOS deployment targets" below.
If you peek in the Xcode folder you'll find:
beta, a script that bumps the build number and then runs
xcodebuildto create an archive suitable for uploading to App Store Connect. See
beta --helpfor more, including how to set up automatic uploads to App Store Connect.
bump, a script that can increment the build, minor, or major version number throughtout the project. See
bump --helpfor more.
And in the Xcode workspace itself you'll find:
SmilieExtractor, an iOS app that takes
showsmilies.webarchiveand extracts resources for Smilie Keyboard. To update smilies, first save a fresh
showsmilies.webarchivefrom the Forums, then run
CopyMarkdownApp, a macOS Safari App Extension that adds a "Copy Awful Markdown" context menu item to the Forums. The copied markdown is ready to be pasted into a GitHub issue.
If you've stashed some .html files from the Forums, you can load those into a debug build of the app. And if you forgot to stash some, you're in luck: we've stashed some as test fixtures. See FixtureURLProtocol for more info.
You can help! See our contribution guidelines.
Awful is broken down somewhat:
Awfulis the iOS app.
AwfulCoreis a framework that does the scraping and networking with the Forums. It's meant to be compatible with all Apple platforms, but nobody's really tried beyond iOS.
Smiliesis a framework that downloads smilies and presents them as a keyboard. It's meant to be compatible with all Apple platforms, but nobody's really tried beyond iOS.
Awful's posts view is fully customizable using CSS. There's a default theme, as well as themes for specific forums such as YOSPOS and FYAD. Internally, we use LESS to generate our CSS, so if you are editing built-in themes please edit the
.lessfiles. (LESS installation instructions are above.) Then commit both the modified
.lessfiles and any resulting changes to
.cssfiles, so others don't need LESS to build Awful.
The rest of Awful is themed in a a big plist. If you can't find a theme key you'd like to use, ask and we'll add it!
Diabolik900 and The Dave have largely fashioned Awful with its own [set of thread tags][thread tags] that look great on the iPhone and the iPad. They're distributed with the app. New thread tags can also appear in Awful without us having to send an update through the App Store. This is done by hosting the icons via GitHub Pages.
To add a new thread tag you just made:
In this (Awful.app) repository, update the
App/Resources/Thread Tagssubmodule and push:
cd path/to/awful-app/repo cd App/Resources/Thread\ Tags git pull origin master cd .. git commit -am "Updated thread tags." git push
Since Awful supports both iOS 10.3 and iOS 11+, there's some hoops to jump through to support alternate app icons. Here's a mini checklist for adding a new alternate app icon:
CFBundleIcons~ipad. Your added key/values will be identical between those two locations, so go ahead and copypasta.
The reason for this silliness: iOS 10.3 requires alternate icons to be loose in the app bundle, while iOS 11+ supports alternate icons in an asset catalog; App Store Connect requires all submissions built using the iOS 11 SDK to have the main app icon in an asset catalog. It seems like the asset catalog compiler merges any
CFBundleIconsvalues it comes across with its own generated values so it works out ok for us.
Awful answers to a couple URL schemes:
awful:opens Awful directly to various screens. This URL scheme is documented at http://handleopenurl.com and at Launch Center Pro.
awful://forumsopens the Forums tab.
awful://forums/:forumidopens the Forums tab to the identified forum.
awful://threads/:threadidopens the first page of the identified thread. For example,
awful://threads/3510131opens Awful's thread.
awful://threads/:threadid/pages/:pageopens the given page of the identified thread. For example,
awful://threads/3510131/pages/15opens the fifteenth page of Awful's thread.
awful://posts/:postidopens the identified post's page of its thread and jumps to it. For example,
awful://posts/408179339opens the OP of Awful's thread.
awful://bookmarksopens the Bookmarks tab.
awful://messagesopens the Messages tab.
awful://messages/:messageidopens the identified private message. (I guess the idea is to handle a link from one message to another?)
awful://settingsopens the Settings tab.
awful://users/:useridopens the identified user's profile. For example,
awful://users/106125opens pokeyman's profile.
awful://banlistopens the Leper's Colony.
awful://banlist/:useridopens the identified user's rap sheet. For example,
awful://banlist/106125opens pokeyman's rap sheet.
awfulhttps:handle Forums website URLs by opening the corresponding screen when possible.
awfulin front, and now it opens in Awful.
|Check out tag/branch|
Awful includes contributions from: