](https://f-droid.org/packages/com.averi.worldscribe/)
7 | [
](https://play.google.com/store/apps/details?id=com.averi.worldscribe)
10 |
11 | ## Overview
12 | Ever wanted to create a fictional setting — for your next novel, comic, screenplay, or what-have-you — but find it difficult to keep everything organized?
13 |
14 | World Scribe eases the creation process by letting you keep track of every important element in your world, including the ways in which they're connected.
15 | ## Features
16 | * World elements — known as **Articles** — can be organized into five categories for your convenience:
17 | * People
18 | * Groups
19 | * Places
20 | * Items
21 | * Concepts
22 | * Any Article can possess **Connections** to other Articles, complete with relationship descriptions. Each Connection also acts as a link to that Article's page. Need to find a character's siblings, or the ancient artifacts on their person? You can navigate to each of them straight from that character's page.
23 | * Any Article can also possess **Snippets**, which are custom text entries unique to that Article. Want to write down an important letter or speech from one of your characters? How about a song or poem warning of a dangerous location in the world? The possibilities are endless!
24 | * Everything you write is stored in simple text files on external storage, so feel free to export your worlds at any time and use them in other writing projects.
25 |
26 | ## How to Use
27 | Simply create a fork or download the repo zip and open up the project in Android Studio.
28 |
29 | Ensure that you have the Android Support libraries installed and updated to the latest version.
30 |
--------------------------------------------------------------------------------
/app/src/main/java/com/averi/worldscribe/activities/BackButtonActivity.java:
--------------------------------------------------------------------------------
1 | package com.averi.worldscribe.activities;
2 |
3 | import android.graphics.PorterDuff;
4 | import android.graphics.drawable.Drawable;
5 | import android.os.Bundle;
6 | import androidx.core.content.ContextCompat;
7 | import android.view.MenuItem;
8 |
9 | import com.averi.worldscribe.R;
10 |
11 | /**
12 | * 13 | * Created by mark on 29/08/16. 14 | *
15 | *16 | * An Activity that has a Back Button on the app bar, allowing the user to go up one level. 17 | *
18 | *19 | * Subclasses must override setAppBar. 20 | *
21 | */ 22 | public abstract class BackButtonActivity extends ThemedActivity { 23 | 24 | @Override 25 | protected void onCreate(Bundle savedInstanceState) { 26 | super.onCreate(savedInstanceState); 27 | } 28 | 29 | @Override 30 | public boolean onOptionsItemSelected(MenuItem item) { 31 | switch (item.getItemId()) { 32 | case android.R.id.home: 33 | finish(); 34 | return true; 35 | default: 36 | return super.onOptionsItemSelected(item); 37 | } 38 | } 39 | 40 | /** 41 | *42 | * Sets up this Activity's app bar, including adding the Back Button. 43 | *
44 | *45 | * Subclasses must override this method, set up the app bar, and then call super. 46 | *
47 | */ 48 | protected void setAppBar() { 49 | final Drawable upArrow = ContextCompat.getDrawable(this, 50 | R.drawable.back_button); 51 | upArrow.setColorFilter(ContextCompat.getColor(this, android.R.color.white), 52 | PorterDuff.Mode.SRC_ATOP); 53 | 54 | assert getSupportActionBar() != null; 55 | getSupportActionBar().setHomeAsUpIndicator(upArrow); 56 | getSupportActionBar().setDisplayHomeAsUpEnabled(true); 57 | getSupportActionBar().setDisplayShowHomeEnabled(true); 58 | } 59 | 60 | } 61 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_load_world.xml: -------------------------------------------------------------------------------- 1 | 2 |8 | * Created by mark on 31/07/16. 9 | *
10 | * 11 | *12 | * Contains a list of all of the Articles that are linked to a certain Article through one 13 | * of the three types of links (Connection, Membership, or Residence). 14 | *
15 | */ 16 | public class LinkedArticleList implements Serializable { 17 | 18 | private HashSet15 | * Credit to InsanityOnABun. The Gist for this class can be found 16 | * here. 17 | *
18 | */ 19 | public class MarqueeToolbar extends Toolbar { 20 | 21 | TextView title; 22 | boolean reflected = false; 23 | 24 | public MarqueeToolbar(Context context) { 25 | super(context); 26 | } 27 | 28 | public MarqueeToolbar(Context context, AttributeSet attrs) { 29 | super(context, attrs); 30 | } 31 | 32 | public MarqueeToolbar(Context context, AttributeSet attrs, int defStyleAttr) { 33 | super(context, attrs, defStyleAttr); 34 | } 35 | 36 | @Override 37 | public void setTitle(CharSequence title) { 38 | if (!reflected) { 39 | reflected = reflectTitle(); 40 | } 41 | super.setTitle(title); 42 | // Due to postDelayed(), selectTitle() will cause an exception if it's called before 43 | // the title TextView has been created. In Activities, setSupportActionBar() might 44 | // call selectTitle() too early, thus causing an exception. 45 | // We can prevent this by checking reflected, which can only be set 46 | // to true if the title TextView exists. 47 | if (reflected) { 48 | selectTitle(); 49 | } 50 | } 51 | 52 | @Override 53 | public void setTitle(int resId) { 54 | if (!reflected) { 55 | reflected = reflectTitle(); 56 | } 57 | super.setTitle(resId); 58 | // Due to postDelayed(), selectTitle() will cause an exception if it's called before 59 | // the title TextView has been created. In Activities, setSupportActionBar() might 60 | // call selectTitle() too early, thus causing an exception. 61 | // We can prevent this by checking reflected, which can only be set 62 | // to true if the title TextView exists. 63 | if (reflected) { 64 | selectTitle(); 65 | } 66 | } 67 | 68 | private boolean reflectTitle() { 69 | try { 70 | Field field = Toolbar.class.getDeclaredField("mTitleTextView"); 71 | field.setAccessible(true); 72 | title = (TextView) field.get(this); 73 | title.setEllipsize(TextUtils.TruncateAt.MARQUEE); 74 | title.setMarqueeRepeatLimit(-1); 75 | return true; 76 | } catch (NoSuchFieldException e) { 77 | e.printStackTrace(); 78 | return false; 79 | } catch (IllegalAccessException e) { 80 | e.printStackTrace(); 81 | return false; 82 | } catch (NullPointerException e) { 83 | e.printStackTrace(); 84 | return false; 85 | } 86 | } 87 | 88 | public void selectTitle() { 89 | title.postDelayed(new Runnable() { 90 | @Override 91 | public void run() { 92 | title.setSelected(true); 93 | } 94 | }, 1000); 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /app/src/main/res/layout/membership_card.xml: -------------------------------------------------------------------------------- 1 | 2 |65 | * This new file will overwrite any existing error log files that were created on the 66 | * same day. 67 | *
68 | * @return An empty error log file whose file name is based on the current date 69 | */ 70 | private DocumentFile generateErrorLogFile() { 71 | Date datum = new Date(); 72 | SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd", Locale.ENGLISH); 73 | String fullName = String.format(ERROR_LOG_FILE_NAME, df.format(datum)); 74 | 75 | DocumentFile appDirectory = FileRetriever.getAppDirectory(context, false); 76 | DocumentFile errorLogFile = DocumentFileCompat.peekFile(appDirectory, fullName, null); 77 | if (errorLogFile != null) { 78 | errorLogFile.delete(); 79 | } 80 | try { 81 | errorLogFile = appDirectory.createFile("text/plain", fullName); 82 | } catch (Exception e) { 83 | //TODO: Handle this exception more elegantly 84 | Log.e("WorldScribe", e.getMessage()); 85 | } 86 | 87 | return errorLogFile; 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /app/src/main/res/layout/connection_card.xml: -------------------------------------------------------------------------------- 1 | 2 |14 | * Created by mark on 22/12/17. 15 | *
16 | *17 | * An Activity that has Action Bar Buttons for toggling between Reader Mode and Editor Mode. 18 | *
19 | *
20 | * Subclasses MUST override {@link #onCreateOptionsMenu(Menu menu)} to inflate the appropriate
21 | * menu, and then return super.onCreateOptionsMenu(Menu menu).
22 | * The inflated menu MUST contain R.id.enableReaderModeItem and
23 | * R.id.enableEditorModeItem.
24 | *