2019-09-24 19:53:43 +00:00
# F-Chat Rising
2019-06-09 23:33:52 +00:00
2019-09-24 19:53:43 +00:00
This repository contains a heavily customized version of the mainline F-Chat 3.0 client.
2019-06-09 23:33:52 +00:00
## Key Differences
2019-09-24 19:53:43 +00:00
1. **Profile matching** automatically compares your profile with others to determine with whom you are compatible.
1. **Automatic ad posting** repeatedly posts and rotates ads on selected channels.
2019-12-07 15:24:06 +00:00
1. **Link previews** pop up shows a preview of an image when you hover your mouse over a link.
2019-09-24 19:53:43 +00:00
2019-12-07 15:24:06 +00:00
### More Details
2019-09-24 19:53:43 +00:00
2019-07-12 22:14:21 +00:00
* Ads view
2019-07-15 16:59:16 +00:00
* Highlight ads from characters most interesting to you
2019-12-07 15:24:06 +00:00
* Hide clearly unmatched ads
2019-09-24 19:53:43 +00:00
* View characters' recent ads
2019-06-09 23:33:52 +00:00
* Ad auto-posting
2019-09-24 19:53:43 +00:00
* Manage channel ad settings via "Tab Settings"
2019-07-03 23:11:12 +00:00
* Automatically re-post ads every 11-18 minutes (randomized) for up to 180 minutes
2019-10-26 21:22:05 +00:00
* Rotate multiple ads on a single channel by entering multiple ads in "Tab Settings"
2019-07-13 17:32:35 +00:00
* Ad ratings
2019-07-07 21:44:32 +00:00
* LFP ads are automatically rated and matched against your profile
2019-06-09 23:33:52 +00:00
* Link previews
* Hover cursor over any `[url]` to see a preview of it
2019-07-04 19:34:21 +00:00
* Middle click any `[url]` to turn the preview into a sticky / interactive mode
2019-06-09 23:33:52 +00:00
* Profile
2019-09-24 19:53:43 +00:00
* Kinks are auto-compared when viewing character profile
2019-06-23 21:48:41 +00:00
* Custom kink explanations can be expanded inline
2019-06-30 19:15:23 +00:00
* Custom kinks are highlighted
2019-10-27 18:58:41 +00:00
* Gender, anthro/human preference, age, sexual preference, and sub/dom preference are highlighted if compatible or incompatible
2019-06-09 23:33:52 +00:00
* Guestbook, friend, and group counts are visible on tabs
2019-07-03 23:11:12 +00:00
* Character images are expanded inline
2019-06-09 23:33:52 +00:00
* Cleaner presentation for the side bar details (age, etc.), sorted in most relevant order
* Less informative side bar details (views, contact) are separated and shown in a less prominent way
2019-06-23 21:48:41 +00:00
* Cleaner guestbook view
2019-10-21 22:55:05 +00:00
* Profiles, images, guestbook posts, and groups are cached for faster view
2019-12-07 15:24:06 +00:00
* Character view tabs (overview, images, etc.) stick to the top
2019-07-30 01:32:33 +00:00
* Character Search
2019-09-24 19:53:43 +00:00
* Search results are sorted based on match scores
* Display match score in search results
* Current search filters are listed in the search dialog
2019-07-30 01:32:33 +00:00
* Search filters can be reset
2019-09-24 19:53:43 +00:00
* General
* Character profiles, guestbooks, friend lists, and image lists are cached for faster access.
2019-10-27 18:58:41 +00:00
* Conversation dialog can be opened by typing in a character name
2019-12-07 15:24:06 +00:00
* Message search also checks character names
2019-09-24 19:53:43 +00:00
2019-10-26 21:22:05 +00:00
## How to Set Up Ads
1. Open a conversation channel of your preference, such as `#LFRP`
1. Click `Tab Settings`
1. Enter one or more `Channel Auto-Posting Ads`
1. Click `Save settings`
1. Click `Auto-Post Ads`
2019-09-24 19:53:43 +00:00
## FAQ
2019-12-07 15:24:06 +00:00
1. The more information you have in your profile (**non-custom** kinks in particular), the better the matching quality will be.
1. Non-binary gender preference matching relies on kinks. For example, if your non-binary character has a preference for females, make sure 'females' are listed as a favorite kink.
2019-10-26 21:22:05 +00:00
1. 'Underage' kink is considered to apply to characters aged 16 or above; 'ageplay' kink is considered to apply to characters aged 16 or below.
2019-09-24 19:53:43 +00:00
1. 'Older characters' and 'younger characters' kink preferences are interpreted as age difference of 5+ years.
2019-12-07 15:24:06 +00:00
1. Comparison results will get faster over time, as more and more character data is cached.
2019-06-09 23:33:52 +00:00
2019-07-04 19:34:21 +00:00
## Todo / Ideas
2019-09-24 19:53:43 +00:00
* Collect data on ads / responses to determine which ads work best
2019-07-04 19:34:21 +00:00
* Preview mode should allow detaching from the main window
2020-03-17 18:06:08 +00:00
* Split chat view / separate window for specific chats?
2019-12-07 15:24:06 +00:00
* Improve log browsing
2019-07-15 16:59:16 +00:00
* Reposition ad settings and toggle
2019-12-07 15:24:06 +00:00
* Save character's status messages
2019-10-26 21:22:05 +00:00
* Conversation bot API
2020-03-17 18:06:08 +00:00
* 'Filter unmatching ads' is not channel specific -- it's either on everywhere or nowhere
2020-03-15 02:31:28 +00:00
* AD UI Cleanup / hide to popovers
2020-03-17 18:06:08 +00:00
* image loading animation
* Ad cache is broken
2020-03-17 22:24:34 +00:00
* Show online / offline status on PM list
2019-06-09 23:33:52 +00:00
2019-09-24 19:53:43 +00:00
2017-09-02 01:50:31 +00:00
# F-List Exported
This repository contains the open source parts of F-list and F-Chat 3.0.
2018-01-06 16:14:21 +00:00
All necessary files to build F-Chat 3.0 as an Electron, mobile or web application are included.
2017-09-02 01:50:31 +00:00
## Setting up a Dev Environment
- Clone the repo
- Install [Yarn ](https://yarnpkg.com/en/docs/install )
2017-10-17 18:21:57 +00:00
- Change into the cloned directory and run `yarn install` . If you only want to make a custom theme, you do not need to do this!
2017-09-02 01:50:31 +00:00
- IntelliJ IDEA is recommended for development.
## Building for Electron
2018-03-04 02:32:26 +00:00
- To build native Node assets, you will need to install Python 2.7 and the Visual C++ 2015 Build tools. [More information can be found in the node-gyp docs. ](https://github.com/nodejs/node-gyp#installation )
2017-09-02 01:50:31 +00:00
- Change into the `electron` directory.
2018-03-04 02:32:26 +00:00
- Run `yarn build` /`yarn watch` to build assets. They are placed into the `app` directory.
2017-09-02 01:50:31 +00:00
- Run `yarn start` to start the app in debug mode. Use `Ctrl+Shift+I` to open the Chromium debugger.
2019-07-08 19:08:16 +00:00
### Building on Windows
```
2019-09-24 19:53:43 +00:00
npm install --global --production --vs2015 --add-python-to-path windows-build-tools node-gyp
2019-07-08 19:08:16 +00:00
```
2017-09-02 01:50:31 +00:00
### Packaging
See https://electron.atom.io/docs/tutorial/application-distribution/
- Run `yarn build:dist` to create a minified production build.
2018-09-28 00:08:10 +00:00
- Run `yarn run pack` . The generated installer is placed into the `dist` directory.
2018-08-10 16:59:37 +00:00
- On Windows you can add the path to and password for a code signing certificate as arguments.
- On Mac you can add your code signing identity as an argument. `zip` is required to be installed.
2018-08-18 19:37:53 +00:00
- On Linux you can add a GPG key for signing and its password as arguments. `mksquashfs` and `zsyncmake` are required to be installed.
2017-09-02 01:50:31 +00:00
2018-01-06 16:14:21 +00:00
## Building for Mobile
- Change into the `mobile` directory.
2018-03-04 02:32:26 +00:00
- Run `yarn build` /`yarn watch` to build assets. They are placed into the `www` directory.
- For Android, change into the `android` directory and run `./gradlew assembleDebug` . The generated APK is placed into `app/build/outputs/apk` .
- For iOS, change into the `ios` directory and open `F-Chat.xcodeproj` using XCode. From there, simply run the app using the play button.
2017-09-02 01:50:31 +00:00
2018-04-08 00:22:32 +00:00
## Building for Web
- Change into the `webchat` directory.
- Run `yarn build` /`yarn watch` to build assets. They are placed into the `dist` directory.
- The compiled main.js file can be included by an HTML file that is expected to provide a global `const chatSettings: {account: string, theme: string, characters: ReadonlyArray<string>, defaultCharacter: string | null};` . It should also normalize the page to 100% height.
2017-10-17 18:21:57 +00:00
## Building a custom theme
See [the wiki ](https://wiki.f-list.net/F-Chat_3.0/Themes ) for instructions on how to create a custom theme.
2018-03-04 02:32:26 +00:00
- Change into the `scss` directory.
2017-10-17 18:21:57 +00:00
- Run `yarn install` .
2018-03-04 02:32:26 +00:00
- Run `yarn build themes/chat/{name}.scss` .
- Your theme file will be placed into the `scss/css` directory.
2017-10-17 18:21:57 +00:00
2017-09-02 01:50:31 +00:00
## Dependencies
Note: Adding *and upgrading* dependencies should only be done with prior consideration and subsequent testing.
That's why `yarn.lock` exists and is version controlled.
2020-03-15 02:31:28 +00:00
To upgrade NPM dependencies, run `yarn upgrade` locally. Run `yarn outdated` to see pending upgrades.
